Skip to content

Commit feff503

Browse files
authored
Add issue and pr templates (#509)
* feat: add issue templates * fix: adjust wording * fix: add nix note
1 parent 013b0e1 commit feff503

3 files changed

Lines changed: 139 additions & 0 deletions

File tree

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
name: Bug Report
2+
description: Report a bug or unexpected behavior
3+
labels: ["bug"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for reporting a bug! Please fill in the details below.
9+
- type: textarea
10+
id: description
11+
attributes:
12+
label: Description
13+
description: A clear description of the bug.
14+
validations:
15+
required: true
16+
- type: textarea
17+
id: reproduction
18+
attributes:
19+
label: Steps to reproduce
20+
description: Minimal code or steps to reproduce the issue.
21+
placeholder: |
22+
```python
23+
import kernels
24+
...
25+
```
26+
validations:
27+
required: true
28+
- type: textarea
29+
id: expected
30+
attributes:
31+
label: Expected behavior
32+
description: What you expected to happen.
33+
validations:
34+
required: true
35+
- type: textarea
36+
id: environment
37+
attributes:
38+
label: Environment
39+
description: Please provide version info.
40+
placeholder: |
41+
- kernels version:
42+
- Python version:
43+
- PyTorch version:
44+
- CUDA version:
45+
- GPU model:
46+
- OS:
47+
- If using the Nix builder, output of `nix-shell -p nix-info --run "nix-info -m"`:
48+
validations:
49+
required: true
50+
- type: textarea
51+
id: additional
52+
attributes:
53+
label: Additional context
54+
description: Any other context, logs, or screenshots.
55+
validations:
56+
required: false
Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
name: Feature Request
2+
description: Propose a new feature or improvement
3+
labels: ["enhancement"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for your interest in contributing! Please describe what you'd like to
9+
see and why. If you're planning to submit a PR, **please open this issue first**
10+
and wait for feedback before starting work - this helps us align on approach and
11+
avoids duplicate or unnecessary effort.
12+
- type: textarea
13+
id: description
14+
attributes:
15+
label: Description
16+
description: A clear description of the feature you'd like.
17+
validations:
18+
required: true
19+
- type: textarea
20+
id: motivation
21+
attributes:
22+
label: Motivation
23+
description: Why is this feature needed? What problem does it solve? What is your use case?
24+
validations:
25+
required: true
26+
- type: textarea
27+
id: proposal
28+
attributes:
29+
label: Proposed approach
30+
description: If you have an idea of how this could be implemented, describe it here. This is especially helpful if you plan to submit a PR.
31+
validations:
32+
required: false
33+
- type: textarea
34+
id: alternatives
35+
attributes:
36+
label: Alternatives considered
37+
description: Any alternative solutions or workarounds you've considered.
38+
validations:
39+
required: false
40+
- type: textarea
41+
id: additional
42+
attributes:
43+
label: Additional context
44+
description: Any other context, references, or screenshots.
45+
validations:
46+
required: false

.github/pull_request_template.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
## Important: Read before submitting
2+
3+
> **New contributors:** Please open or comment on an issue **before** submitting a
4+
> PR to discuss the change you'd like to make. This helps us align on approach and
5+
> avoids wasted effort on changes we may not be able to merge.
6+
7+
## Related issue
8+
9+
<!-- Link the issue this PR addresses. Every PR should have a corresponding issue. -->
10+
11+
Closes #
12+
13+
## What does this PR do?
14+
15+
<!-- A brief description of the changes. -->
16+
17+
## Motivation
18+
19+
<!-- Why is this change needed? What context is important for reviewers? -->
20+
21+
## Changes
22+
23+
<!-- Bulleted list of key changes. -->
24+
25+
-
26+
27+
## Testing
28+
29+
<!-- How were these changes tested? Include commands, test output, or benchmarks. -->
30+
31+
-
32+
33+
## Checklist
34+
35+
- [ ] This PR is linked to an issue that was discussed and approved
36+
- [ ] I have tested these changes locally
37+
- [ ] New/changed functionality has test coverage

0 commit comments

Comments
 (0)