Skip to content

Commit

Permalink
adds issue and pr templates
Browse files Browse the repository at this point in the history
  • Loading branch information
jmbhughes committed Mar 10, 2024
1 parent 60a80bb commit a1dd19c
Show file tree
Hide file tree
Showing 5 changed files with 92 additions and 0 deletions.
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
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.

**Desktop (please complete the following information):**
- OS: [e.g. iOS]
- Version [e.g. 22]

**Additional context**
Add any other context about the problem here.
9 changes: 9 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
name: Documentation
about: Improve documentation
title: ''
labels: documentation
assignees:
---

**How could we improve the documentation?**
9 changes: 9 additions & 0 deletions .github/ISSUE_TEMPLATE/everything_else.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
name: Everything else
about: Anything not covered by another issue type
title: ''
labels:
assignees:
---

**What would you like to report?**
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
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: ''
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.
23 changes: 23 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
## PR summary

*What does this PR introduce?*

## Todos

*Please list tasks to complete this PR.*

- [ ] implement new feature or fix bug
- [ ] include tests
- [ ] update associated documentation entry

## Test plan

*How does this PR verify the code works correctly?*

## Breaking changes

*Document any breaking changes from this PR.*

## Related Issues

*Link the issues related to this PR.*

0 comments on commit a1dd19c

Please sign in to comment.