-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
efc2684
commit bf1d486
Showing
1 changed file
with
24 additions
and
26 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,40 +1,38 @@ | ||
# 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 | ||
|
||
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. | ||
### How does it solve the problem? | ||
|
||
- [ ] Adequate Unit tests | ||
- [ ] Unit tests are passing | ||
- [ ] Features work as expected/bug fixes resolve issue | ||
- [ ] Other means of quality insurance added (if necessary) | ||
- Implements XY class. | ||
|
||
## Checklist: | ||
### How are the changes tested? | ||
|
||
Before you submit your pull request, please make sure you have completed the following steps: | ||
- Added test_xy. | ||
|
||
- [ ] 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. | ||
## Checklist for Contributors | ||
|
||
### Reviewers: | ||
- [ ] 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. | ||
|
||
Add specific reviewers to this PR who may have a keen interest in or expertise related to this submission. | ||
|
||
## Checklist for Reviewers: | ||
|
||
- [ ] 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. |