Add Pull Request Template (#4298)

* add: pull request template

* Update pull_request_template.md

* add: squash and merge clause

* add: "explain why" reaffirm for breaking change
This commit is contained in:
Shivam Goyal
2022-11-09 20:19:00 +05:30
committed by GitHub Enterprise
parent 6ec3c4fc74
commit 7d7f4ceb47

34
.github/pull_request_template.md vendored Normal file
View File

@@ -0,0 +1,34 @@
<!--- Add a pull request title above in this format -->
<!--- real example: 'AE-0001 | Applying MVVM Model' -->
<!--- 'AE-JiraIssueNumber | JiraIssueTitle' (JiraIssueNumber can be removed if not available) -->
## Description of what I changed
<!--- Please include a summary of the change, relevant motivation and context -->
<!--- It can simply be your commit message, which you must have -->
## Issue I worked on
<!--- Please add the issue number at the end -->
<!--- Delete section if an issue is not available -->
JIRA Issue: https://navihq.atlassian.net/browse/AE-####
## Type of change I made
<!--- Please delete options that are not relevant -->
- [ ] 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 not work as expected, explain why)
- [ ] Refactoring / Maintenance (non-breaking change to keep the project healthy)
## QA Requirement for my changes
<!--- Please delete options that are not relevant -->
- [ ] QA is required for this change (QA Owner: @github-username)
- [ ] QA is not required for this change
## Checklist: I completed these to help reviewers :)
<!--- Put an `x` in the box if you did the task -->
- [ ] I am able to build the project locally with my changes
- [ ] My changes generate no new warnings
- [ ] My code follows the style guidelines of this project & spotless check passes
- [ ] I have performed a self-review of my own code
- [ ] I have made corresponding changes to the documentation
- [ ] I understand that **'Squash and merge'** is the preferred merge