Skip to content

Commit

Permalink
docs(templates): add bug, feature and pr template
Browse files Browse the repository at this point in the history
* docs(templates): add bug and feature template

* docs(templates): add pr template
  • Loading branch information
dhommen committed Jan 23, 2024
1 parent 7c673c6 commit 5aa2aa8
Show file tree
Hide file tree
Showing 3 changed files with 118 additions and 0 deletions.
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
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.

---

32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
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.

---

48 changes: 48 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
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.

---

0 comments on commit 5aa2aa8

Please sign in to comment.