diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..6af0587 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -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. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..5328040 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -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. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..efa5859 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,44 @@ + + +## 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 + +