From efc2684e79a2a47faffa0f2c45aae5ed12bf03ef Mon Sep 17 00:00:00 2001 From: Jakob Elias Wagner Date: Fri, 9 Feb 2024 10:16:41 +0100 Subject: [PATCH 1/2] 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. From e63a1ef7770b9516a82e3c1e4b480b51ac9a6426 Mon Sep 17 00:00:00 2001 From: Samuel Burbulla Date: Fri, 9 Feb 2024 11:56:15 +0100 Subject: [PATCH 2/2] Update pull_request template. --- .github/pull_request_template.md | 48 +++++++++++++++----------------- 1 file changed, 22 insertions(+), 26 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 9fcade16..dc789922 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,40 +1,36 @@ -# Type of PR | Pull Request Name +# Bugfix/Feature/Cleanup: PR 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. +### Which issue does this PR tackle? -Fixes # (issue) + - XY functionality is not implemented. + - Fixes # (issue) -## Validation and Tests +### How does it solve the problem? -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. + - Implements XY class. -- [ ] Adequate Unit tests -- [ ] Unit tests are passing -- [ ] Features work as expected/bug fixes resolve issue -- [ ] Other means of quality insurance added (if necessary) +### How are the changes tested? -## Checklist: + - Added test_xy. -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 +## Checklist for Contributors -## Pull Request Details +- [ ] Scope: This PR tackles exactly one problem. +- [ ] Conventions: The branch follows the `feature/title-slug` convention. +- [ ] Conventions: The PR title follows the `Bugfix: Title` convention. +- [ ] Coding style: The code passes all pre-commit hooks. +- [ ] Documentation: All changes are well-documented. +- [ ] Tests: New features are tested and all tests pass successfully. +- [ ] Changelog: Updated CHANGELOG.md for new features or breaking changes. +- [ ] Review: A suitable reviewer has been assigned. -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: +## Checklist for Reviewers: -Add specific reviewers to this PR who may have a keen interest in or expertise related to this submission. +- [ ] The PR solves the issue it claims to solve and only this one. +- [ ] Changes are tested sufficiently and all tests pass. +- [ ] Documentation is complete and well-written. +- [ ] Changelog has been updated, if necessary.