Skip to content

Commit ad19152

Browse files
tomschrtomschr
authored
Fix #6: Create issue templates (#7)
To simplify collaborating and have consistent issues, we use GitHub issue templates.
1 parent 2ea3d2f commit ad19152

4 files changed

Lines changed: 211 additions & 0 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug-report.yml‎

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
name: Bug Report
2+
description: Report a reproducible bug or unexpected behavior.
3+
labels: [bug]
4+
assignees: [tomschr]
5+
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thanks for reporting a bug! Please fill out the details below so we can help.
11+
12+
- type: input
13+
id: project_version
14+
attributes:
15+
label: Project Version
16+
description: What version of this project are you using?
17+
placeholder: e.g., 1.2.3
18+
validations:
19+
required: true
20+
21+
- type: dropdown
22+
id: python_version
23+
attributes:
24+
label: Python Version
25+
description: Which version of Python is the problem with?
26+
multiple: true
27+
options:
28+
- "3.11"
29+
- "3.12"
30+
- "3.13"
31+
- "3.14"
32+
validations:
33+
required: true
34+
35+
- type: dropdown
36+
id: os
37+
attributes:
38+
label: Operating System
39+
description: What operating system are you using?
40+
multiple: true
41+
options:
42+
- Linux
43+
- Windows
44+
- macOS
45+
- Other (describe below)
46+
validations:
47+
required: true
48+
49+
- type: textarea
50+
id: steps_to_reproduce
51+
attributes:
52+
label: Steps to Reproduce
53+
description: How can we reproduce the issue? Please provide a minimal example.
54+
placeholder: |
55+
1. Run this command...
56+
2. See this output...
57+
validations:
58+
required: true
59+
60+
- type: textarea
61+
id: expected_behavior
62+
attributes:
63+
label: Expected Behavior
64+
description: What did you expect to happen?
65+
placeholder: |
66+
I expected the command to return this output...
67+
Or, I expected the application to behave like this...
68+
validations:
69+
required: false
70+
71+
- type: textarea
72+
id: actual_behavior
73+
attributes:
74+
label: Actual Behavior
75+
description: What actually happened?
76+
placeholder: |
77+
Instead, I got this output...
78+
Or, the application crashed with this error...
79+
validations:
80+
required: false
81+
82+
- type: textarea
83+
id: environment
84+
attributes:
85+
label: Additional Information
86+
description: |
87+
Any other relevant information? (e.g., logs, environment variables, installed packages)
88+
placeholder: |
89+
- Logs:
90+
- Output from the command:
91+
- Error messages:
92+
- Environment variables:
93+
- Installed packages:
94+
validations:
95+
required: false

‎.github/ISSUE_TEMPLATE/docs-update.yml‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
name: Documentation Update
2+
description: Propose improvements or corrections to the documentation.
3+
labels: [documentation]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Help us improve the documentation! Please describe what needs updating.
9+
10+
- type: input
11+
id: affected_section
12+
attributes:
13+
label: Affected Documentation Section
14+
description: Which part of the docs needs updating?
15+
placeholder: e.g., README, Installation section, Usage instructions
16+
validations:
17+
required: true
18+
19+
- type: textarea
20+
id: suggestion
21+
attributes:
22+
label: Suggested Change
23+
description: What should be changed or improved?
24+
validations:
25+
required: true
26+
27+
- type: textarea
28+
id: additional_info
29+
attributes:
30+
label: Additional Context
31+
description: Any other information, screenshots, or references?
32+
validations:
33+
required: false

‎.github/ISSUE_TEMPLATE/feature-request.yml‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
name: Feature Request
2+
description: Suggest an idea or request a new feature.
3+
labels: [enhancement]
4+
assignees: [tomschr]
5+
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thank you for your suggestion! Please provide as much detail as possible.
11+
12+
- type: textarea
13+
id: situation
14+
attributes:
15+
label: Situation
16+
description: A clear and concise description of what the feature is. Ex. I'm always frustrated when [...]
17+
placeholder: Describe the situation...
18+
validations:
19+
required: true
20+
21+
- type: textarea
22+
id: use_case
23+
attributes:
24+
label: Use Case
25+
description: Why is this feature useful? What problem does it solve?
26+
validations:
27+
required: true
28+
29+
- type: textarea
30+
id: implementation
31+
attributes:
32+
label: Possible Implementation
33+
description: Do you have any ideas on how this could be implemented?
34+
validations:
35+
required: false

‎.github/pull_request_template.yml‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
name: Pull Request
2+
description: Template for pull requests
3+
4+
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: "Thank you for your pull request! Please fill in the checklist below."
9+
10+
- type: input
11+
id: description
12+
attributes:
13+
label: Description
14+
description: Describe your changes.
15+
placeholder: adds logging to the application
16+
validations:
17+
required: true
18+
19+
- type: input
20+
id: related_issues
21+
attributes:
22+
label: Related Issues
23+
description: |
24+
List any related issues or pull requests.
25+
If not applicable, leave it blank or write "n/a".
26+
placeholder: e.g., Fixes #123, Closes #456
27+
validations:
28+
required: true
29+
30+
- type: checkboxes
31+
id: type_of_change
32+
attributes:
33+
label: Type of Change
34+
options:
35+
- label: Bug fix
36+
- label: New feature
37+
- label: Documentation update
38+
- label: Other (describe below)
39+
validations:
40+
required: true
41+
42+
- type: textarea
43+
id: additional_notes
44+
attributes:
45+
label: Additional Notes
46+
description: Add any other context or screenshots here.
47+
validations:
48+
required: false

0 commit comments

Comments
 (0)