-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(templates): add bug, feature and pr template
* docs(templates): add bug and feature template * docs(templates): add pr template
- Loading branch information
Showing
3 changed files
with
118 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
--- | ||
name: Bug Report | ||
about: Create a report to help us improve | ||
title: "[BUG] Short description of the bug" | ||
labels: bug | ||
assignees: '' | ||
|
||
--- | ||
|
||
**Describe the Bug** | ||
A clear and concise description of what the bug is. | ||
|
||
**To Reproduce** | ||
Steps to reproduce the behavior: | ||
1. Go to '...' | ||
2. Click on '....' | ||
3. Scroll down to '....' | ||
4. See error | ||
|
||
**Expected Behavior** | ||
A clear and concise description of what you expected to happen. | ||
|
||
**Screenshots** | ||
If applicable, add screenshots to help explain your problem. | ||
|
||
**Environment (please complete the following information):** | ||
- OS: [e.g. iOS, Windows] | ||
- Browser [e.g. chrome, safari] | ||
- Version [e.g. 22] | ||
|
||
**Additional Context** | ||
Add any other context about the problem here. This might include the area of the codebase the bug concerns, potential suspects for the root cause, etc. | ||
|
||
**Logs** | ||
If applicable, include logs to help with the diagnosis. Be sure to remove any sensitive information from logs. | ||
|
||
--- | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
--- | ||
name: Feature Request | ||
about: Suggest an idea for this project | ||
title: "[FEATURE] Brief description of the new feature" | ||
labels: enhancement | ||
assignees: '' | ||
|
||
--- | ||
|
||
**Is your feature request related to a problem? Please describe.** | ||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | ||
|
||
**Describe the solution you'd like** | ||
A detailed description of what you want to happen. | ||
|
||
**Describe alternatives you've considered** | ||
A clear and concise description of any alternative solutions or features you've considered. | ||
|
||
**Additional context** | ||
Add any other context or screenshots about the feature request here. | ||
|
||
**Potential Benefits** | ||
Explain the benefits this feature would bring to the project and its users. | ||
|
||
**Possible Drawbacks** | ||
Discuss any potential drawbacks or challenges that the implementation of this feature might entail. | ||
|
||
**Examples in Other Projects** | ||
If applicable, provide examples of how this feature or something similar is implemented in other projects or platforms. This can give additional context and insight into how the feature might work. | ||
|
||
--- | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
--- | ||
name: Pull Request | ||
about: Create a pull request to propose and collaborate on changes | ||
title: "[PR] Your brief description here" | ||
labels: '' | ||
assignees: '' | ||
|
||
--- | ||
|
||
**Related Issue(s)** | ||
Link any related issues here that this PR addresses. | ||
|
||
**Problem** | ||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | ||
|
||
**Solution** | ||
Describe the modifications you've made. A clear and concise description of what you want to happen. | ||
|
||
**Implementation Details** | ||
- List any significant logic or architectural decisions you made and the reasoning behind them. | ||
- Describe any new components, methods, or dependencies in your code. | ||
|
||
**Risk Impact** | ||
Assess the risk level of your changes (e.g., low, medium, high) and explain why. | ||
|
||
**Performance Implications** | ||
If applicable, note any performance implications or considerations for the changes you have made. | ||
|
||
**Testing Performed** | ||
Detail the testing steps you have taken to ensure the functionality and performance of your code. Include any relevant automated or manual testing procedures. | ||
|
||
**Screenshots** | ||
If applicable, add screenshots to help explain your pull request. | ||
|
||
**Checklist:** | ||
- [ ] My code follows the project's style guidelines | ||
- [ ] I have performed a self-review of my own code | ||
- [ ] I have commented my code, particularly in hard-to-understand areas | ||
- [ ] I have made corresponding changes to the documentation | ||
- [ ] My changes generate no new warnings | ||
- [ ] I have added tests that prove my fix is effective or that my feature works | ||
- [ ] New and existing unit tests pass locally with my changes | ||
|
||
**Additional Notes** | ||
Add any other context or notes about the pull request here. | ||
|
||
--- | ||
|