From 8c7caca5a78d0f83658a25409abf8291f4a802b7 Mon Sep 17 00:00:00 2001 From: Laura Murgatroyd <60604372+lauramurgatroyd@users.noreply.github.com> Date: Mon, 31 Jul 2023 09:15:19 +0100 Subject: [PATCH] Create pull_request_template.md (#224) * Create pull_request_template.md * Update with conventions * Automated autoyapf fixes --------- Co-authored-by: github-actions --- .github/workflows/pull_request_template.md | 26 ++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 .github/workflows/pull_request_template.md diff --git a/.github/workflows/pull_request_template.md b/.github/workflows/pull_request_template.md new file mode 100644 index 00000000..569c9424 --- /dev/null +++ b/.github/workflows/pull_request_template.md @@ -0,0 +1,26 @@ +## Describe your changes + + +## Describe any testing you have performed +*Consider adding example code to [examples](https://github.com/vais-ral/CILViewer/tree/pr-template/Wrappers/Python/examples)* + + +## Link relevant issues + + +## Checklist when you are ready to request a review + +- [ ] I have performed a self-review of my code +- [ ] I have added docstrings in line with the guidance in the [CIL developer guide](https://tomographicimaging.github.io/CIL/nightly/developer_guide.html) +- [ ] I have implemented unit tests that cover any new or modified functionality +- [ ] CHANGELOG.md has been updated with any functionality change +- [ ] Request review from all relevant developers +- [ ] Change pull request label to 'waiting for review' + +## Contribution Notes +- [ ] The content of this Pull Request (the Contribution) is intentionally submitted for inclusion in CILViewer (the Work) under the terms and conditions of the [Apache-2.0 License](https://spdx.org/licenses/Apache-2.0.html) +- [ ] I confirm that the contribution does not violate any intellectual property rights of third parties + +Qt contributions should follow Qt naming conventions i.e. camelCase method names. + +VTK contributions should follow VTK naming conventions i.e. PascalCase method names.