From f10c685cda14b5ba6ab33e8088fe3e925ddbbbb1 Mon Sep 17 00:00:00 2001 From: Timothy <75321887+timothy-nunn@users.noreply.github.com> Date: Wed, 6 Sep 2023 17:18:33 +0100 Subject: [PATCH 1/3] Add issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 34 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 +++++++++++++ .github/ISSUE_TEMPLATE/other-issues.md | 10 +++++++ 3 files changed, 64 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/other-issues.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000000..c1cc4cf93d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,34 @@ +--- +name: Bug report +about: Create a report to help us improve +title: "[BUG]" +labels: bug +assignees: '' + +--- + +## Describe the bug + + + +## Steps to reproduce + + + +## Expected behaviour + + + +## Evidence + + +## Environment + +- OS: +- Version: + +## Additional context + + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000000..105495f8de --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: '' +assignees: '' + +--- + + + +## Description of issue / requirement to address + + + +## Proposed solution + + diff --git a/.github/ISSUE_TEMPLATE/other-issues.md b/.github/ISSUE_TEMPLATE/other-issues.md new file mode 100644 index 0000000000..55ff2f020e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/other-issues.md @@ -0,0 +1,10 @@ +--- +name: Other issues +about: For issues that are not bug reports or feature requests +title: '' +labels: '' +assignees: '' + +--- + + From b2e0db8b80a93e51da6bf1c8a7992ed5527f5796 Mon Sep 17 00:00:00 2001 From: Timothy Nunn Date: Thu, 7 Sep 2023 11:14:43 +0100 Subject: [PATCH 2/3] Add pull request template --- .github/pull_request_template.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 .github/pull_request_template.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000000..db95883183 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,22 @@ +## Description + + + +## Checklist + +I confirm that I have completed the following checks: + +**Testing** +- [ ] If I have changed any of the Python or Fortran code, I have rebuilt and run the tests locally and they have passed. +- [ ] I have addressed any 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. + +**Quality** +- [ ] I have ensured my changes are formatted correctly and conform to PROCESS' quality standards. +- [ ] If I have made documentation changes, I have checked they render correctly. + +**Miscellaneous** +- [ ] I have created a changelog entry for my change, if appropriate. +- [ ] I have added documentation for my change, if appropriate. +- [ ] **I confirm my contribution is made to PROCESS under an MIT license**. \ No newline at end of file From 1404a080a330f028634ba316c0e12a914f35b437 Mon Sep 17 00:00:00 2001 From: Timothy Nunn Date: Fri, 8 Sep 2023 13:30:20 +0100 Subject: [PATCH 3/3] Slim down PR checklist --- .github/pull_request_template.md | 11 +---------- 1 file changed, 1 insertion(+), 10 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index db95883183..d182944d99 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -6,17 +6,8 @@ I confirm that I have completed the following checks: -**Testing** -- [ ] If I have changed any of the Python or Fortran code, I have rebuilt and run the tests locally and they have passed. -- [ ] I have addressed any differences in the regression tests caused by this pull request in the comments. +- [ ] 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. - -**Quality** -- [ ] I have ensured my changes are formatted correctly and conform to PROCESS' quality standards. - [ ] If I have made documentation changes, I have checked they render correctly. - -**Miscellaneous** -- [ ] I have created a changelog entry for my change, if appropriate. - [ ] I have added documentation for my change, if appropriate. -- [ ] **I confirm my contribution is made to PROCESS under an MIT license**. \ No newline at end of file