Skip to content

Commit 0ca4456

Browse files
authored
Update pull-request-template.md (#13)
* Update pull-request-template.md * Update pull request template based on team discussion * Update phrasing and revert task list changes * Update checklist phrasing
1 parent fba5ae5 commit 0ca4456

File tree

1 file changed

+13
-22
lines changed

1 file changed

+13
-22
lines changed

.github/pull-request-template.md

Lines changed: 13 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,30 @@
1-
### What does this PR do?
2-
3-
Describe the overall purpose of the PR changes. Doesn't need to be as specific as the
4-
individual commits.
5-
6-
### Helpful background context
7-
8-
Describe any additional context beyond what the PR accomplishes if it is likely to be
9-
useful to a reviewer.
10-
11-
Delete this section if it isn't applicable to the PR.
1+
### Purpose and background context
2+
Describe the overall purpose of the PR changes and any useful background context.
123

134
### How can a reviewer manually see the effects of these changes?
14-
155
Explain how to see the proposed changes in the application if possible.
166

177
Delete this section if it isn't applicable to the PR.
188

199
### Includes new or updated dependencies?
10+
YES | NO
2011

12+
### Changes expectations for external applications?
2113
YES | NO
2214

2315
### What are the relevant tickets?
24-
25-
Include links to Jira Software and/or Jira Service Management tickets here.
16+
- Include links to Jira Software and/or Jira Service Management tickets here.
2617

2718
### Developer
28-
29-
- [ ] All new ENV is documented in README (or there is none)
19+
- [ ] All new ENV is documented in README
20+
- [ ] All new ENV has been added to staging and production environments
21+
- [ ] All related Jira tickets are linked in commit message(s)
3022
- [ ] Stakeholder approval has been confirmed (or is not needed)
3123

32-
### Code Reviewer
33-
34-
- [ ] The commit message is clear and follows our guidelines
35-
(not just this pull request message)
24+
### Code Reviewer(s)
25+
- [ ] The commit message is clear and follows our guidelines (not just this PR message)
3626
- [ ] There are appropriate tests covering any new functionality
37-
- [ ] The documentation has been updated or is unnecessary
38-
- [ ] The changes have been verified
27+
- [ ] The provided documentation is sufficient for understanding any new functionality introduced
28+
- [ ] Any manual tests have been performed and verified
3929
- [ ] New dependencies are appropriate or there were no changes
30+

0 commit comments

Comments
 (0)