Skip to content

Commit 5c8ce8f

Browse files
committed
Add issue and PR templates
1 parent de3ed62 commit 5c8ce8f

File tree

4 files changed

+149
-0
lines changed

4 files changed

+149
-0
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
name: Bug Report
2+
description: Create a report to help us improve
3+
title: "[Bug]: "
4+
labels: ["bug", "triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to fill out this bug report!
10+
11+
- type: textarea
12+
id: what-happened
13+
attributes:
14+
label: Describe the bug
15+
description: A clear and concise description of what the bug is.
16+
placeholder: Tell us what you see!
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: reproduce
22+
attributes:
23+
label: To Reproduce
24+
description: "Steps to reproduce the behavior. Please provide a minimal, self-contained code sample."
25+
placeholder: |
26+
```python
27+
import numpy as np
28+
from radius_clustering import RadiusClustering
29+
30+
# Your code here that triggers the bug
31+
```
32+
validations:
33+
required: true
34+
35+
- type: textarea
36+
id: expected
37+
attributes:
38+
label: Expected behavior
39+
description: A clear and concise description of what you expected to happen.
40+
validations:
41+
required: true
42+
43+
- type: dropdown
44+
id: os
45+
attributes:
46+
label: Operating System
47+
description: What operating system are you using?
48+
options:
49+
- Windows
50+
- macOS
51+
- Linux
52+
validations:
53+
required: true
54+
55+
- type: input
56+
id: python-version
57+
attributes:
58+
label: Python Version
59+
placeholder: "e.g. 3.11.4"
60+
validations:
61+
required: true
62+
63+
- type: input
64+
id: package-version
65+
attributes:
66+
label: Package Version
67+
placeholder: "e.g. 1.4.0"
68+
validations:
69+
required: true
70+
71+
- type: textarea
72+
id: additional-context
73+
attributes:
74+
label: Additional context
75+
description: Add any other context about the problem here.
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
name: Documentation improvement
2+
description: Create a report to help us improve the documentation. Alternatively you can just open a pull request with the suggested change.
3+
labels: [Documentation, 'Needs Triage']
4+
5+
body:
6+
- type: textarea
7+
attributes:
8+
label: Describe the issue linked to the documentation
9+
description: >
10+
Tell us about the confusion introduced in the documentation.
11+
validations:
12+
required: true
13+
- type: textarea
14+
attributes:
15+
label: Suggest a potential alternative/fix
16+
description: >
17+
Tell us how we could improve the documentation in this regard.
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
name: Feature Request
2+
description: Suggest an idea for this project
3+
title: "[Feature]: "
4+
labels: ["enhancement"]
5+
body:
6+
- type: textarea
7+
attributes:
8+
label: Is your feature request related to a problem? Please describe.
9+
description: A clear and concise description of what the problem is. Ex. "I'm always frustrated when..."
10+
validations:
11+
required: true
12+
- type: textarea
13+
attributes:
14+
label: Describe the solution you'd like
15+
description: A clear and concise description of what you want to happen.
16+
validations:
17+
required: true
18+
- type: textarea
19+
attributes:
20+
label: Describe alternatives you've considered
21+
description: A clear and concise description of any alternative solutions or features you've considered.
22+
- type: textarea
23+
attributes:
24+
label: Additional context
25+
description: Add any other context or screenshots about the feature request here.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
## Description
2+
3+
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
4+
5+
Fixes # (issue)
6+
7+
## Type of change
8+
9+
Please delete options that are not relevant.
10+
11+
- [ ] Bug fix (non-breaking change which fixes an issue)
12+
- [ ] New feature (non-breaking change which adds functionality)
13+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
14+
- [ ] This change requires a documentation update
15+
16+
## How Has This Been Tested?
17+
18+
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration.
19+
20+
- [ ] Test A
21+
- [ ] Test B
22+
23+
## Checklist:
24+
25+
- [ ] My code follows the style guidelines of this project
26+
- [ ] I have performed a self-review of my own code
27+
- [ ] I have commented my code, particularly in hard-to-understand areas
28+
- [ ] I have made corresponding changes to the documentation
29+
- [ ] My changes generate no new warnings
30+
- [ ] I have added tests that prove my fix is effective or that my feature works
31+
- [ ] New and existing unit tests pass locally with my changes
32+
- [ ] Any dependent changes have been merged and published in downstream modules

0 commit comments

Comments
 (0)