-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add issue and pr templates (#8)
- Loading branch information
Showing
3 changed files
with
91 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,27 @@ | ||
--- | ||
name: Bug report | ||
about: Create a report to help us improve | ||
title: [BUG] | ||
labels: bug, help wanted | ||
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. | ||
|
||
**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,20 @@ | ||
--- | ||
name: Feature request | ||
about: Suggest an idea for this project | ||
title: [FEAT] | ||
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 clear and concise 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. |
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,44 @@ | ||
<!-- | ||
Please give your pull request a short but descriptive title. | ||
Use conventional commits to separate and summarize commits logically: | ||
https://www.conventionalcommits.org/en/v1.0.0/ | ||
Use this template as a guide. Omit sections that don't apply. | ||
🙈 Don't be lazy. Try to fill out the template well. | ||
--> | ||
|
||
## Description | ||
|
||
Describe what this pull request changes, and why. Include implications for people using this change. | ||
|
||
Useful information to include: | ||
- Which user roles will this change impact? Common user roles are "Learner", "Course Author", | ||
"Developer", and "Operator". | ||
- Include screenshots for changes to the UI (ideally, both "before" and "after" screenshots, if applicable). | ||
- Provide links to the description of corresponding configuration changes. Remember to correctly annotate these | ||
changes. | ||
|
||
## Testing instructions | ||
|
||
Please provide detailed step-by-step instructions for testing this change. | ||
|
||
## Additional information | ||
|
||
Include anything else that will help reviewers and consumers understand the change. | ||
- Does this change depend on other changes elsewhere? | ||
- Any special concerns or limitations? For example: deprecations, migrations, security, or accessibility. | ||
- Link to other information about the change, such as Jira issues, GitHub issues, or Discourse discussions. | ||
|
||
## Checklist for Merge | ||
|
||
- [ ] Tested in a remote environment | ||
- [ ] Updated documentation | ||
- [ ] Rebased master/main | ||
- [ ] Squashed commits | ||
|
||
<!-- | ||
You can put NA in the checklist if it doesn't apply | ||
- [x] Check that dont't apply / NA | ||
--> |