From efc2684e79a2a47faffa0f2c45aae5ed12bf03ef Mon Sep 17 00:00:00 2001 From: Jakob Elias Wagner Date: Fri, 9 Feb 2024 10:16:41 +0100 Subject: [PATCH] Add pull request template --- .github/pull_request_template.md | 40 ++++++++++++++++++++++++++++++++ 1 file changed, 40 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 00000000..9fcade16 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,40 @@ +# Type of PR | Pull Request Name + +## Description + +Please include a summary of the change and which issue is fixed. +Include relevant motivation and context. +List any dependencies that are required for this change. + +Fixes # (issue) + +## Validation and Tests + +Describe the tests that verify the changes that are not included in the CI. +Provide instructions to reproduce if relevant. +Provide relevant details for test configuration. +Delete not relevant options. + +- [ ] Adequate Unit tests +- [ ] Unit tests are passing +- [ ] Features work as expected/bug fixes resolve issue +- [ ] Other means of quality insurance added (if necessary) + +## Checklist: + +Before you submit your pull request, please make sure you have completed the following steps: + +- [ ] Self-review +- [ ] Concise and well-written comments +- [ ] Documentation has been updated +- [ ] Changes generate no new warnings +- [ ] Any dependent changes have been merged + +## Pull Request Details + +Please provide more details about the pull request. +For example, screen captures of new features, gif of animation, or link to the live demo. + +### Reviewers: + +Add specific reviewers to this PR who may have a keen interest in or expertise related to this submission.