Skip to content

Commit

Permalink
Merge pull request #823 from gchq/docs/new_pr_template
Browse files Browse the repository at this point in the history
docs: update PR template
  • Loading branch information
rg936672 authored Nov 7, 2024
2 parents a227120 + 9a9717e commit 567cf7d
Showing 1 changed file with 8 additions and 17 deletions.
25 changes: 8 additions & 17 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
### PR Type
<!--
What kind of change does this PR introduce? Remove any that do not apply.
What kind of change does this PR introduce? Delete any that do not apply.
-->

- Bugfix
Expand All @@ -14,41 +14,32 @@

### Description
<!--
Please include a summary of the changes and the related issue. Please also include relevant motivation and context.
Summarise the changes and the related issue. Include relevant motivation and context. Include screenshots if useful.
-->

(Write your answer here.)

### How Has This Been Tested?
<!--
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.
Describe the tests that you ran to verify the changes. List any relevant details for your test configuration.
-->

Test A: (Write your answer here.)
Test B: (Write your answer here.)
Test C: (Write your answer here.)
Existing tests pass as expected.

New tests introduced with this change verify that...

### Does this PR introduce a breaking change?
<!--
What changes might users need to make in their application due to this PR?.
-->

(Write your answer here.)

### Screenshots
<!--
Include the before and after if your changes include differences in HTML/CSS
-->

(Write your answer here.)

### Checklist before requesting a review
- [ ] I have made sure that my PR is not a duplicate.
- [ ] My code follows the style guidelines of this project.
- [ ] I have commented my code, particularly in hard-to-understand areas.
- [ ] I have ensured my code is easy to understand, including docstrings and comments where necessary.
- [ ] I have performed a self-review of my code.
- [ ] I have made corresponding changes to the documentation.
- [ ] My changes generate no new warnings.
- [ ] I have added tests that prove my fix is effective or that my feature works.
- [ ] New and existing unit tests pass locally with my changes.
- [ ] Any dependent changes have been merged and published in downstream modules.
- [ ] I have updated CHANGELOG.md, if appropriate.

0 comments on commit 567cf7d

Please sign in to comment.