Skip to content

Add issue and PR templates #2895

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jonmaddock merged 3 commits into from
Sep 12, 2023
Merged

Add issue and PR templates #2895

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f10c685
Add issue templates
timothy-nunn Sep 6, 2023
b2e0db8
Add pull request template
timothy-nunn Sep 7, 2023
1404a08
Slim down PR checklist
timothy-nunn Sep 8, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
name: Bug report
about: Create a report to help us improve
title: "[BUG]"
labels: bug
assignees: ''

---

## Describe the bug

<!---A clear and concise description of what the bug is.--->

## Steps to reproduce

<!---
Steps to reproduce the behaviour including any input files
--->

## Expected behaviour

<!--- A clear and concise description of what you expected to happen. --->

## Evidence
<!--- Tracebacks or screenshots. --->

## Environment

- OS: <!-- [e.g. Ubuntu 18.04] -->
- Version: <!-- [e.g. 3.0.0] -->

## Additional context

<!-- Add any other context about the problem here. -->
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
View file
Open in desktop
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: ''
assignees: ''

---

<!--
Please see the CONTRIBUTING.MD guide before creating feature requests.
-->

## Description of issue / requirement to address

<!-- A clear and concise description of what the problem is. Please attach any references to papers for model introduction/change requests. -->

## Proposed solution

<!-- A clear and concise description of what you want to happen. -->
10 changes: 10 additions & 0 deletions .github/ISSUE_TEMPLATE/other-issues.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
name: Other issues
about: For issues that are not bug reports or feature requests
title: ''
labels: ''
assignees: ''

---

<!--- Please consider whether this issue will be better suited to the Discussion section of this GitHub repository --->
13 changes: 13 additions & 0 deletions .github/pull_request_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
## Description

<!-- What does this PR do? Please list any issue that these changes address and how you have gone about implementing the changes -->

## Checklist

I confirm that I have completed the following checks:

- [ ] I have justified any large differences in the regression tests caused by this pull request in the comments.
- [ ] I have added new tests where appropriate for the changes I have made.
- [ ] If I have had to change any existing unit or integration tests, I have justified this change in the pull request comments.
- [ ] If I have made documentation changes, I have checked they render correctly.
- [ ] I have added documentation for my change, if appropriate.