From b4c24960e0da6a2c8b44c81ac7438a20acd79744 Mon Sep 17 00:00:00 2001 From: Graham Hukill Date: Tue, 3 Sep 2024 12:41:27 -0400 Subject: [PATCH] update pull request template --- .github/PULL_REQUEST_TEMPLATE.md | 33 ++++++++++++++++---------------- 1 file changed, 17 insertions(+), 16 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 0e800c4..ad4ef3f 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,28 +1,29 @@ -#### Includes new or updated dependencies? +### Purpose and background context +Describe the overall purpose of the PR changes and any useful background context. -YES | NO +### How can a reviewer manually see the effects of these changes? +Explain how to see the proposed changes in the application if possible. -#### Changes expectations for external applications? +Delete this section if it isn't applicable to the PR. +### Includes new or updated dependencies? YES | NO -#### Developer +### Changes expectations for external applications? +YES | NO +### What are the relevant tickets? +- Include links to Jira Software and/or Jira Service Management tickets here. + +### Developer - [ ] All new ENV is documented in README - [ ] All new ENV has been added to staging and production environments - [ ] All related Jira tickets are linked in commit message(s) +- [ ] Stakeholder approval has been confirmed (or is not needed) -#### How can a reviewer manually see the effects of these changes? - -Explain how to see the proposed changes in the application. - -Delete this section if it isn't applicable to the PR. - -#### Code Reviewer - -- [ ] The commit message is clear and follows our guidelines - (not just this pull request message) +### Code Reviewer(s) +- [ ] The commit message is clear and follows our guidelines (not just this PR message) - [ ] There are appropriate tests covering any new functionality -- [ ] The documentation has been updated or is unnecessary -- [ ] The changes have been verified +- [ ] The provided documentation is sufficient for understanding any new functionality introduced +- [ ] Any manual tests have been performed **or** provided examples verified - [ ] New dependencies are appropriate or there were no changes