Skip to content

Commit 9ec2903

Browse files
kkraus14kkraus14
authored
Add pull request and issue templates copied from CCCL (#551)
* Add pull request template from CCCL * Add issue templates from CCCL
1 parent 899ccee commit 9ec2903

File tree

3 files changed

+217
-0
lines changed

3 files changed

+217
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
name: Bug Report
2+
description: Create a report to help us improve
3+
title: '[BUG]: '
4+
labels: ['bug']
5+
body:
6+
- type: checkboxes
7+
id: check-duplicates
8+
attributes:
9+
label: Is this a duplicate?
10+
description: Check for duplicate issues.
11+
options:
12+
- label: I confirmed there appear to be no [duplicate issues](https://github.com/NVIDIA/cuda-python/issues) for this bug and that I agree to the [Code of Conduct](CODE_OF_CONDUCT.md)
13+
required: true
14+
15+
- type: dropdown
16+
id: bug-type
17+
attributes:
18+
label: Type of Bug
19+
description: What kind of bug are you running into?
20+
multiple: false
21+
options:
22+
- Silent Failure
23+
- Runtime Error
24+
- Compile-time Error
25+
- Performance
26+
- Something else
27+
validations:
28+
required: true
29+
30+
- type: dropdown
31+
id: component
32+
attributes:
33+
label: Component
34+
description: Which cuda-python component does this apply to?
35+
multiple: false
36+
options:
37+
- cuda.bindings
38+
- cuda.core
39+
- General cuda-python
40+
- Infrastructure
41+
- Not sure
42+
validations:
43+
required: true
44+
45+
- type: textarea
46+
id: description
47+
attributes:
48+
label: Describe the bug
49+
description: A clear and concise description of what problem you are running into.
50+
placeholder: "Attempting to compile a program via `cuda.core.experimental.Program.compile` throws a `ValueError`."
51+
validations:
52+
required: true
53+
54+
- type: textarea
55+
id: reproduction
56+
attributes:
57+
label: How to Reproduce
58+
description: Steps used to reproduce the bug.
59+
placeholder: |
60+
0. Construct a `cuda.core.experimental.Program` instance
61+
1. Call the `.compile(...)` method of the instance
62+
2. The call throws a `ValueError` with the following:
63+
```
64+
ValueError: Unsupported target_type="..." (supported_target_types=('ptx', 'cubin', 'ltoir'))
65+
```
66+
validations:
67+
required: true
68+
69+
- type: textarea
70+
id: expected-behavior
71+
attributes:
72+
label: Expected behavior
73+
description: A clear and concise description of what you expected to happen.
74+
placeholder: "Using `cuda.core.experimental.Program.compile(...)` should run successfully and not throw a `ValueError`"
75+
validations:
76+
required: true
77+
78+
- type: markdown
79+
attributes:
80+
value: '# System information'
81+
82+
- type: input
83+
id: operating-system
84+
attributes:
85+
label: Operating System
86+
description:
87+
If applicable, the OS version where this bug occurs.
88+
placeholder: Ubuntu Linux 20.04
89+
validations:
90+
required: false
91+
92+
- type: textarea
93+
id: nvidia-smi-output
94+
attributes:
95+
label: nvidia-smi output
96+
description: If applicable, the output from running the `nvidia-smi` command.
97+
placeholder: |
98+
+-----------------------------------------------------------------------------+
99+
| NVIDIA-SMI 495.29.05 Driver Version: 495.29.05 CUDA Version: 11.5 |
100+
|-------------------------------+----------------------+----------------------+
101+
| GPU Name Persistence-M| Bus-Id Disp.A | Volatile Uncorr. ECC |
102+
| Fan Temp Perf Pwr:Usage/Cap| Memory-Usage | GPU-Util Compute M. |
103+
| | | MIG M. |
104+
|===============================+======================+======================|
105+
| 0 NVIDIA GeForce ... Off | 00000000:41:00.0 On | N/A |
106+
| 0% 25C P8 8W / 320W | 491MiB / 10015MiB | 0% Default |
107+
| | | N/A |
108+
+-------------------------------+----------------------+----------------------+
109+
validations:
110+
required: false
111+

‎.github/ISSUE_TEMPLATE/doc_request.yml‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
name: Documentation Request
2+
description: Suggest an idea to improve cuda-python
3+
title: '[DOC]: '
4+
labels: ['doc']
5+
6+
body:
7+
- type: checkboxes
8+
id: check-duplicates
9+
attributes:
10+
label: Is this a duplicate?
11+
description: Check for duplicate issues.
12+
options:
13+
- label: I confirmed there appear to be no [duplicate issues](https://github.com/NVIDIA/cuda-python/issues) for this bug and that I agree to the [Code of Conduct](CODE_OF_CONDUCT.md)
14+
required: true
15+
16+
- type: dropdown
17+
id: new_or_correction
18+
attributes:
19+
label: Is this for new documentation, or an update to existing docs?
20+
options:
21+
- New
22+
- Update
23+
validations:
24+
required: true
25+
26+
- type: textarea
27+
id: problem
28+
attributes:
29+
label: Describe the incorrect/future/missing documentation
30+
placeholder: "Example: A code snippet mentions function foo(args) but I cannot find any documentation on it."
31+
validations:
32+
required: true
33+
34+
- type: textarea
35+
id: search_locs
36+
attributes:
37+
label: If this is a correction, please provide a link to the incorrect documentation. If this is a new documentation request, please link to where you have looked.
38+
placeholder: |
39+
https://nvidia.github.io/cuda-python/latest/
40+

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
name: Feature Request
2+
description: Suggest an idea to improve cuda-python
3+
title: '[FEA]: '
4+
labels: ['feature request']
5+
body:
6+
- type: checkboxes
7+
id: check-duplicates
8+
attributes:
9+
label: Is this a duplicate?
10+
description: Check for duplicate issues.
11+
options:
12+
- label: I confirmed there appear to be no [duplicate issues](https://github.com/NVIDIA/cuda-python/issues) for this request and that I agree to the [Code of Conduct](CODE_OF_CONDUCT.md)
13+
14+
- type: dropdown
15+
id: area
16+
attributes:
17+
label: Area
18+
description: What area does this request apply to?
19+
multiple: false
20+
options:
21+
- cuda.bindings
22+
- cuda.core
23+
- General cuda-python
24+
- Infrastructure
25+
- Not sure
26+
validations:
27+
required: true
28+
29+
- type: textarea
30+
id: description
31+
attributes:
32+
label: Is your feature request related to a problem? Please describe.
33+
description: A clear and concise description of what the problem is, e.g., "I would like to be able to..."
34+
placeholder: I would like to be able to use the equivalent of `cuda.core.experimental.Program.compile(...)` to compile my code to PTX.
35+
validations:
36+
required: true
37+
38+
- type: textarea
39+
id: proposed-solution
40+
attributes:
41+
label: Describe the solution you'd like
42+
description: A clear and concise description of what you want to happen.
43+
placeholder: |
44+
Support a `ptx` target_type in the `cuda.core.experimental.Program.compile(...)` function.
45+
validations:
46+
required: true
47+
48+
- type: textarea
49+
id: alternatives
50+
attributes:
51+
label: Describe alternatives you've considered
52+
description:
53+
If applicable, please add a clear and concise description of any alternative solutions or features you've
54+
considered.
55+
placeholder: The alternatives to using `cuda.core.experimental.Program.compile(...)` are unappealing. They usually involve using lower level bindings to something like nvRTC or invoking the nvcc executable.
56+
validations:
57+
required: false
58+
59+
- type: textarea
60+
id: additional-context
61+
attributes:
62+
label: Additional context
63+
description: Add any other context about the request here.
64+
placeholder: This would be helpful to have a more productive development cycle in working at the intersection of CUDA and Python for my project.
65+
validations:
66+
required: false

0 commit comments

Comments
 (0)