-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #30 from GSA/feature/DIGITAL-109-pr-template
DIGITAL-109: Proposed PR template
- Loading branch information
Showing
1 changed file
with
58 additions
and
0 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 |
---|---|---|
@@ -0,0 +1,58 @@ | ||
<!-- Delete any detail that does not apply to this PR! --> | ||
|
||
## Jira ticket | ||
|
||
<!-- Insert a link to the Jira ticket (e.g DIGITAL-XXX). --> | ||
<!-- Update the example below with number and paste url to ticket in the () --> | ||
<!-- Should match the following [DIGITAL-xxx](www.pathtoticket.com) --> | ||
[DIGITAL-]() | ||
|
||
## Purpose | ||
|
||
<!--Insert a brief summary of the changes included in this PR and any additional information or context which may help the reviewer. | ||
It can be helpful to understand: | ||
1. What the solution is, | ||
2. Why this approach was chosen, | ||
3. How you implemented the change | ||
4. Possible limitations of this approach and alternate solution paths. --> | ||
|
||
## Includes the following PRs that must be merged first | ||
|
||
<!-- Optional: List any PRs that must be merged before this one can be reviewed. --> | ||
|
||
## Deployment and testing | ||
|
||
### Local Setup | ||
|
||
<!--Insert any required steps to take before beginning to test. Such as `lando rebuild`, rebuilding frontend or config updates needed to follow the testing steps.--> | ||
|
||
### QA/Testing instructions | ||
|
||
<!--Insert steps to test and confirm the result meets the "definition of done".--> | ||
|
||
## Checklist for the Developer | ||
|
||
<!--- Go over all the following points, and put an `x` in all the boxes that apply. --> | ||
<!--- If you're unsure about any of these, don't hesitate to ask for help! --> | ||
- [ ] A link to the JIRA ticket has been included above. | ||
- [ ] No merge conflicts exist with the target branch. | ||
- [ ] Automated tests have passed on this PR. | ||
- [ ] A reviewer has been designated. | ||
- [ ] Deployment and testing steps have been documented above, if applicable. | ||
|
||
## Checklist for the Peer Reviewers | ||
|
||
- [ ] The file changes are relevant to the task objective. | ||
- [ ] Code is readable and includes appropriate commenting. | ||
- [ ] Code standards and best practices are followed. | ||
- [ ] QA/Test steps were successfully completed, if applicable. | ||
- [ ] Applicable logs are free of errors. | ||
|
||
<!-- | ||
Before opening this PR, make sure you’ve done whichever of these applies to you: | ||
- Branch is up-to-date and includes latest from `develop` | ||
- Target branch is correct | ||
- You have ran code standards locally before assigning -`./robo.sh validate:all` | ||
- PR is clear in both the reason it was opened and how the reviewer can confirm the work is done | ||
--> |