Skip to content

Commit 2445a32

Browse files
Merge pull request #209 from swatisehgal/templates
Add PR and issue templates for dra-driver-cpu
2 parents 7b0cce9 + a9a6ec4 commit 2445a32

4 files changed

Lines changed: 146 additions & 1 deletion

File tree

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
---
2+
name: Bug Report
3+
about: Report a bug encountered while using DRA Driver CPU
4+
labels: kind/bug
5+
---
6+
7+
<!--
8+
Please use this template while reporting a bug and provide as much info as possible.
9+
Not doing so may result in your bug not being addressed in a timely manner. Thanks!
10+
11+
If the matter is security related, please disclose it privately via:
12+
https://kubernetes.io/security/
13+
-->
14+
15+
**What happened**:
16+
17+
**What you expected to happen**:
18+
19+
**How to reproduce it (as minimally and precisely as possible)**:
20+
21+
**Context / setup details**:
22+
23+
<!--
24+
Describe the workload shape and any config that may affect driver behavior.
25+
For example: ResourceClaim type, pod/container resources, CDI/NRI settings,
26+
cpuManagerPolicy, cgroup version, etc.
27+
-->
28+
29+
**Relevant logs or outputs**:
30+
31+
<!--
32+
Please include relevant snippets from:
33+
- DRA driver logs
34+
- kubelet logs (if relevant)
35+
- container runtime logs (if relevant)
36+
- `kubectl describe pod`, `kubectl get resourceclaims`, etc.
37+
-->
38+
39+
```text
40+
# paste logs/output here
41+
```
42+
43+
**Question / what you want to verify**:
44+
45+
<!--
46+
If you are unsure this is a bug, describe what behavior or configuration you
47+
want maintainers to validate.
48+
-->
49+
50+
**Diagnostics (`dracpu-gatherinfo`)**:
51+
52+
<!--
53+
Please run `dracpu-gatherinfo` from the affected driver pod and attach the output.
54+
Single node example:
55+
56+
kubectl exec -n dra-driver-cpu <dracpu-pod> -- /dracpu-gatherinfo --stdout
57+
58+
For multi-node issues, collect one report per affected node.
59+
For more details, see:
60+
https://github.com/kubernetes-sigs/dra-driver-cpu/blob/main/docs/gatherinfo.md
61+
-->
62+
63+
```text
64+
# paste dracpu-gatherinfo output here
65+
```
66+
67+
**Environment**:
68+
- DRA driver version/tag (image tag or commit SHA):
69+
- DRA driver mode (`grouped` or `individual`):
70+
- DRA grouped mode setting (`numanode` or `socket`, if applicable):
71+
- Container runtime and version (optional):
72+
- Kubernetes version (use `kubectl version`):
73+
- Cloud provider or hardware configuration:
74+
- OS (e.g. `cat /etc/os-release`):
75+
- Kernel (e.g. `uname -a`):
76+
- Network plugin and version (if this is a network-related bug):
77+
- Others:
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
name: Enhancement Request
3+
about: Suggest an enhancement to DRA Driver CPU
4+
labels: kind/feature
5+
---
6+
7+
<!-- Please only use this template for submitting enhancement requests. -->
8+
9+
**What would you like to be added**:
10+
11+
**Why is this needed**:

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
<!--
2+
Thanks for contributing to dra-driver-cpu.
3+
4+
Please fill in the sections below so reviewers can quickly understand scope,
5+
risk, and validation. If a section does not apply, write "N/A".
6+
-->
7+
8+
## What type of PR is this?
9+
10+
<!-- Add one or more labels in the PR comments, for example:
11+
/kind bug
12+
/kind feature
13+
/kind documentation
14+
/kind cleanup
15+
/kind deprecation
16+
/kind regression
17+
-->
18+
19+
## What this PR does / why we need it
20+
21+
## Which issue(s) this PR is related to
22+
23+
<!--
24+
Use "Fixes #<issue>" when applicable.
25+
For cross-repo issues, include the full URL.
26+
-->
27+
28+
## Special notes for reviewers
29+
30+
<!--
31+
Call out anything that is useful for review:
32+
- API or behavior changes
33+
- migration impact
34+
- compatibility concerns
35+
- follow-up work
36+
-->
37+
38+
## Release note
39+
40+
<!--
41+
If this change is not user-facing, write:
42+
NONE
43+
-->
44+
45+
```release-note
46+
47+
```
48+
49+
## Documentation updates
50+
51+
<!--
52+
List docs changed by this PR or write NONE.
53+
Example:
54+
- README updates
55+
- Helm chart docs
56+
- release process docs
57+
-->

.pre-commit-config.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ repos:
2828
rev: 0.7.22
2929
hooks:
3030
- id: mdformat
31-
exclude: (\.chglog/.*|deployment/helm/.*)\.md
31+
exclude: (\.chglog/.*|deployment/helm/.*|\.github/ISSUE_TEMPLATE/.*)\.md
3232
additional_dependencies:
3333
- mdformat-toc
3434
- mdformat-tables

0 commit comments

Comments
 (0)