Skip to content

Commit 71972a2

Browse files
Merge pull request #5 from Johnny-Knighten/docs/add-issue-and-pr-templates
fix: added pr and issue templates for repo
2 parents ce03177 + b62257e commit 71972a2

File tree

3 files changed

+83
-0
lines changed

3 files changed

+83
-0
lines changed

.github/ISSUE_TEMPLATE/bug-report.md

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
name: Bug Report
3+
about: Create a report to help us improve
4+
title: "{BUG}"
5+
labels: bug
6+
assignees: Johnny-Knighten
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
1. Go to '...'
16+
2. Click on '....'
17+
3. Scroll down to '....'
18+
4. See error
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Screenshots**
24+
If applicable, add screenshots to help explain your problem.
25+
26+
**Additional context**
27+
Add any other context about the problem here.
+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature Request
3+
about: Suggest an idea for this project
4+
title: "[Feature Request]"
5+
labels: enhancement
6+
assignees: Johnny-Knighten
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

.github/pull_request_template.md

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
## Description
2+
Include a summary of the change and which issue is fixed. Also, include relevant motivation and context. List any dependencies that are required for this change.
3+
4+
## Issue/Ticket Number and Link (If Relevant)
5+
6+
* Issue #: LINK HERE
7+
* Ticket #: LINK HERE
8+
9+
## Type of Change
10+
Please delete options that are not relevant.
11+
12+
- [ ] Bug fix (non-breaking change which fixes an issue)
13+
- [ ] New feature (non-breaking change which adds functionality)
14+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
15+
- [ ] This change requires a documentation update
16+
17+
## How Has This Been Tested?
18+
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration.
19+
20+
- [ ] Test A
21+
- [ ] Test B
22+
- ...
23+
24+
## Checklist:
25+
Before you submit your Pull Request, make sure you have done the following:
26+
27+
- [ ] I have read the [CONTRIBUTING](CONTRIBUTING.md) document.
28+
- [ ] My code follows the code style of this project.
29+
- [ ] I have checked that my code does not duplicate any existing code (including PRs).
30+
- [ ] I have tested my code and made sure it works as expected.
31+
- [ ] My change requires a change to the documentation, and I have updated the documentation accordingly.
32+
- [ ] I have provided a detailed description of my changes above.
33+
- [ ] I have linked any related issues or PRs in my changes.
34+
35+
## Additional Notes
36+
Please add any additional notes regarding this pull request here.

0 commit comments

Comments
 (0)