diff options
Diffstat (limited to '.github/PULL_REQUEST_TEMPLATE.md')
| -rw-r--r-- | .github/PULL_REQUEST_TEMPLATE.md | 64 |
1 files changed, 34 insertions, 30 deletions
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 3686c8b3..e9b644f4 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,40 +1,44 @@ -<!-- Provide a descriptive summary of your changes in the title above --> +<!-- Provide a descriptive summary of the changes in the title above --> -## Types of changes -<!-- Remove lines that don't apply --> -- Bug fix (non-breaking change which fixes an issue) -- New feature (non-breaking change which adds functionality) -- Breaking change (fix or feature that would cause existing functionality to change) +#### ISSUE TYPE +<!-- Pick relevant types and delete the rest --> +- Bug fix +- Improvement/feature implementation +- Breaking changes -## Description -<!-- Describe your changes in detail --> +#### RUNTIME ENVIRONMENT +<!-- Include details of your runtime environment --> +- Ranger version/commit: +- Python version: +- Operating system and version: +#### CHECKLIST +<!-- All [REQUIRED] requisites need to be fulfilled --> +<!-- Replace [ ] with [X] when fulfilled --> +- [ ] The `CONTRIBUTING` document has been read **[REQUIRED]** +- [ ] All changes follow the code style **[REQUIRED]** +- [ ] All new and existing tests pass **[REQUIRED]** +- [ ] Changes require config files to be updated + - [ ] Config files have been updated +- [ ] Changes require documentation to be updated + - [ ] Documentation has been updated +- [ ] Changes require tests to be updated + - [ ] Tests have been updated -## Motivation and context -<!-- Why is this change required? --> -<!-- What problem does it solve? --> -<!-- Link to relevant issue(s) --> +#### DESCRIPTION +<!-- Describe the changes in detail --> -## Testing -<!-- What's your testing environment? --> -<!-- What tests have you run? --> -<!-- How does your changes affect other areas of the codebase? --> +#### MOTIVATION AND CONTEXT +<!-- Why are these changes required? --> +<!-- What problem does it solve? --> +<!-- Link to relevant issues --> -## Screenshots/Video<!-- Only if relevant --> +#### TESTING +<!-- What tests have been run? --> +<!-- How does the changes affect other areas of the codebase? --> -## Checklist -<!-- Please go over all the following points --> -<!-- Replace [ ] with [X] when fulfilled --> -<!-- All [REQUIRED] requisites need to be fulfilled --> -- [ ] The **CONTRIBUTING** document has been read **[REQUIRED]** -- [ ] All changes follow the code style of this project **[REQUIRED]** -- [ ] All new and existing tests pass **[REQUIRED]** -- [ ] Changes require documentation to be updated - - [ ] Documentation has been updated -- [ ] Changes require config files to be updated - - [ ] Config files have been updated -- [ ] Changes require tests to be updated - - [ ] Tests have been updated +#### IMAGES / VIDEOS<!-- Only if relevant --> +<!-- Link or embed images and videos of screenshots, sketches etc. --> |