Skip to content

Commit 984fc15

Browse files
authored
chore: add GitHub issue templates (#215)
## Summary by Sourcery Chores: - Create standardized issue templates for bug reports, feature requests, documentation improvements, and internal improvements
1 parent f044def commit 984fc15

File tree

4 files changed

+113
-0
lines changed

4 files changed

+113
-0
lines changed
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ""
5+
labels: "bug"
6+
assignees: ""
7+
---
8+
9+
**Describe the bug**
10+
A clear and concise description of what the bug is.
11+
12+
**To Reproduce**
13+
Steps to reproduce the behavior:
14+
15+
1. Save data into '...'
16+
2. Run command '...'
17+
3. See error
18+
19+
**Expected behavior**
20+
A clear and concise description of what you expected to happen.
21+
22+
**Screenshots**
23+
If applicable, add screenshots to help explain your problem.
24+
25+
**Environment (please complete the relevant information):**
26+
27+
- OS: [e.g. macOS 12.6, Windows 11, Ubuntu 22.04]
28+
- Project version: [e.g. 0.39.0]
29+
- Other relevant dependencies:
30+
31+
**Possible Solution**
32+
If you have ideas about what might be causing the issue or how to fix it, please share them here.
33+
34+
**Additional context**
35+
Add any other context about the problem here.
36+
37+
**Would you be willing to submit a PR for this bug?**
38+
Let us know if you'd be interested in contributing a fix.
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
name: Documentation
3+
about: Suggest improvements or report issues with documentation
4+
title: ""
5+
labels: "documentation"
6+
assignees: ""
7+
---
8+
9+
**Is your documentation request related to a problem? Please describe.**
10+
A clear and concise description of what the documentation issue is.
11+
For instance: I found the documentation for [feature] confusing because [...]
12+
13+
**Describe what documentation needs to be added or improved**
14+
A clear and concise description of what documentation changes you'd like to see.
15+
16+
**Affected documentation pages or sections**
17+
Please list the specific pages, sections, or files that need attention:
18+
19+
- [e.g., README.md, API documentation, installation guide]
20+
21+
**Proposed changes (if applicable)**
22+
If you have specific suggestions for how the documentation should be changed, please describe them here.
23+
24+
**Additional information or examples**
25+
Add any other context, references, screenshots, or examples that would help improve the documentation.
26+
27+
**Would you be willing to contribute to this documentation improvement?**
28+
Let us know if you'd be interested in submitting a PR for this change.
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ""
5+
labels: "enhancement"
6+
assignees: ""
7+
---
8+
9+
**Is your feature request related to a problem? Please describe.**
10+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
11+
12+
**Describe the solution you'd like**
13+
A clear and concise description of what you want to happen.
14+
15+
**Describe alternatives you've considered**
16+
A clear and concise description of any alternative solutions or features you've considered.
17+
18+
**Benefits**
19+
What benefits will this feature bring to the project and its users?
20+
21+
**Additional context**
22+
Add any other context or screenshots about the feature request here.
23+
24+
**Would you be willing to implement this feature?**
25+
Let us know if you'd be interested in submitting a PR for this feature.
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
name: Internal Improvement
3+
about: Suggest an improvement to the project's internal tooling, dependencies, or processes
4+
title: ""
5+
labels: "enhancement, internal"
6+
assignees: ""
7+
---
8+
9+
**Is your improvement request related to a problem? Please describe.**
10+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
11+
12+
**Describe the improvement you'd like**
13+
A clear and concise description of what you want to happen.
14+
15+
**Describe alternatives you've considered**
16+
A clear and concise description of any alternative solutions or improvements you've considered.
17+
18+
**Benefits**
19+
What benefits will this improvement bring to the project?
20+
21+
**Additional context**
22+
Add any other context or screenshots about the improvement here.

0 commit comments

Comments
 (0)