-
-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: add issue and pull request templates
- Loading branch information
Showing
15 changed files
with
175 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,3 @@ | ||
# Every request must be reviewed and accepted by: | ||
|
||
* @felangel |
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,2 @@ | ||
github: [felangel] | ||
patreon: felangel |
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,25 @@ | ||
--- | ||
name: Bug Report | ||
about: Create a report to help us improve | ||
title: "fix: " | ||
labels: bug | ||
--- | ||
|
||
**Description** | ||
A clear and concise description of what the bug is. | ||
|
||
**Steps To Reproduce** | ||
|
||
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. | ||
|
||
**Additional Context** | ||
Add any other context about the problem here. |
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,10 @@ | ||
--- | ||
name: Build System | ||
about: Changes that affect the build system or external dependencies | ||
title: "build: " | ||
labels: build | ||
--- | ||
|
||
**Description** | ||
|
||
Describe what changes need to be done to the build system and why |
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,10 @@ | ||
--- | ||
name: Chore | ||
about: Other changes that don't modify src or test files | ||
title: "chore: " | ||
labels: chore | ||
--- | ||
|
||
**Description** | ||
|
||
Clearly describe what change is needed and why. If this changes code then please use another issue type. |
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,10 @@ | ||
--- | ||
name: Continuous Integration | ||
about: Changes to the CI configuration files and scripts | ||
title: "ci: " | ||
labels: ci | ||
--- | ||
|
||
**Description** | ||
|
||
Describe what changes need to be done to the ci/cd system and why |
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 @@ | ||
blank_issues_enabled: false |
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,10 @@ | ||
--- | ||
name: Documentation | ||
about: Improve the documentation so all collaborators have a common understanding | ||
title: "docs: " | ||
labels: documentation | ||
--- | ||
|
||
**Description** | ||
|
||
Clearly describe what documentation you are looking to add or improve. |
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,22 @@ | ||
--- | ||
name: Feature Request | ||
about: A new feature to be added to the project | ||
title: "feat: " | ||
labels: feature | ||
--- | ||
|
||
**Description** | ||
|
||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | ||
|
||
**Desired Solution** | ||
|
||
A clear and concise description of what you want to happen. | ||
|
||
**Alternatives 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 go here. |
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,10 @@ | ||
--- | ||
name: Performance Update | ||
about: A code change that improves performance | ||
title: "perf: " | ||
labels: performance | ||
--- | ||
|
||
**Description** | ||
|
||
Clearly describe what code needs to be changed and what the performance impact is going to be. |
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,10 @@ | ||
--- | ||
name: Refactor | ||
about: A code change that neither fixes a bug nor adds a feature | ||
title: "refactor: " | ||
labels: refactor | ||
--- | ||
|
||
**Description** | ||
|
||
Clearly describe what needs to be refactored any why. Please provide links to related issues (bugs or upcoming features) in order to help prioritize. |
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,10 @@ | ||
--- | ||
name: Revert Commit | ||
about: Reverts a previous commit | ||
title: "revert: " | ||
labels: revert | ||
--- | ||
|
||
**Description** | ||
|
||
Provide a link to a PR/Commit that you are looking to revert and why. |
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,10 @@ | ||
--- | ||
name: Style Changes | ||
about: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) | ||
title: "style: " | ||
labels: style | ||
--- | ||
|
||
**Description** | ||
|
||
Clearly describe what you are looking to change and why. |
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,10 @@ | ||
--- | ||
name: Test | ||
about: Adding missing tests or correcting existing tests | ||
title: "test: " | ||
labels: test | ||
--- | ||
|
||
**Description** | ||
|
||
List out the tests that need to be added or changed. Please also include any information as to why this was not covered in the past. |
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 @@ | ||
<!-- | ||
Thanks for contributing! | ||
Provide a description of your changes below and a general summary in the title | ||
Please look at the following checklist to ensure that your PR can be accepted quickly: | ||
--> | ||
|
||
## Status | ||
|
||
**READY/IN DEVELOPMENT/HOLD** | ||
|
||
## Breaking Changes | ||
|
||
YES | NO | ||
|
||
## Description | ||
|
||
<!--- Describe your changes in detail --> | ||
|
||
## Type of Change | ||
|
||
<!--- Put an `x` in all the boxes that apply: --> | ||
|
||
- [ ] ✨ New feature (non-breaking change which adds functionality) | ||
- [ ] 🛠️ Bug fix (non-breaking change which fixes an issue) | ||
- [ ] ❌ Breaking change (fix or feature that would cause existing functionality to change) | ||
- [ ] 🧹 Code refactor | ||
- [ ] ✅ Build configuration change | ||
- [ ] 📝 Documentation | ||
- [ ] 🧪 Tests | ||
- [ ] 🗑️ Chore |