|
| 1 | +--- |
| 2 | +id: pull-request-template |
| 3 | +title: Pull Request Template |
| 4 | +--- |
| 5 | + |
| 6 | + |
| 7 | +# Generic Pull Request Template |
| 8 | + |
| 9 | +Add a file called pull_request_template.md to the root directory of your repository |
| 10 | + |
| 11 | +## Title |
| 12 | +Provide a general summary of your changes in the title. |
| 13 | + |
| 14 | +## Description |
| 15 | + |
| 16 | +Describe your changes in detail |
| 17 | + |
| 18 | +## Motivation, context and link to the ticket |
| 19 | + |
| 20 | +Why is this change required? What problem does it solve? |
| 21 | +Link to the related Jira ticket. |
| 22 | + |
| 23 | +## Related PRs |
| 24 | +Link to related pull requests |
| 25 | + |
| 26 | +## How has this been tested? |
| 27 | +Please describe in detail how you tested your changes. |
| 28 | + |
| 29 | +Include details of your testing environment, and the tests you ran to |
| 30 | + |
| 31 | +See how your change affects other areas of the code, etc. |
| 32 | + |
| 33 | +## Screenshots (if appropriate): |
| 34 | + |
| 35 | + |
| 36 | +## Types of changes |
| 37 | +What types of changes does your code introduce? Put an x in all the boxes that apply: |
| 38 | + |
| 39 | +[ ] Bug fix (non-breaking change which fixes an issue) |
| 40 | + |
| 41 | +[ ] New feature (non-breaking change which adds functionality) |
| 42 | + |
| 43 | +[ ] Breaking change (fix or feature that would cause existing functionality to change) |
| 44 | + |
| 45 | +[ ] Documentation Update (if none of the other choices apply) |
| 46 | + |
| 47 | +## Checklist |
| 48 | +Go over all the following points, and put an x in all the boxes that apply. |
| 49 | +If you're unsure about any of these, don't hesitate to ask. Your team members are there to help! |
| 50 | + |
| 51 | +[ ] My code follows the code style of this project. |
| 52 | + |
| 53 | +[ ] I have updated the documentation accordingly. |
| 54 | + |
| 55 | +[ ] I have added tests to cover my changes. |
| 56 | + |
| 57 | +[ ] All new and existing tests passed. |
| 58 | + |
| 59 | +[ ] One or more required reviews requested. |
| 60 | + |
| 61 | +[ ] Any dependent changes have been merged and published in downstream modules |
| 62 | + |
| 63 | +[ ] I have updated and verified the database schema changes and related documentation have been updated. |
0 commit comments