From eb04dcca0e9848fc4a1ead309be9ef89e8a40d12 Mon Sep 17 00:00:00 2001 From: jonavellecuerdo Date: Thu, 8 Feb 2024 11:43:56 -0500 Subject: [PATCH] Update PR template --- .github/pull-request-template.md | 33 ++++++++++++-------------------- 1 file changed, 12 insertions(+), 21 deletions(-) diff --git a/.github/pull-request-template.md b/.github/pull-request-template.md index 1f3d331..df6cc2b 100644 --- a/.github/pull-request-template.md +++ b/.github/pull-request-template.md @@ -1,38 +1,29 @@ -### What does this PR do? - -Describe the overall purpose of the PR changes. Doesn't need to be as specific as the -individual commits. - -### Helpful background context - -Describe any additional context beyond what the PR accomplishes if it is likely to be -useful to a reviewer. - -Delete this section if it isn't applicable to the PR. +### Purpose and background context +Describe the overall purpose of the PR changes and any useful background context. ### How can a reviewer manually see the effects of these changes? - Explain how to see the proposed changes in the application if possible. Delete this section if it isn't applicable to the PR. ### Includes new or updated dependencies? +YES | NO +### Changes expectations for external applications? YES | NO ### What are the relevant tickets? - -Include links to Jira Software and/or Jira Service Management tickets here. +- Include links to Jira Software and/or Jira Service Management tickets here. ### Developer - -- [ ] All new ENV is documented in README (or there is none) +- [ ] 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) -### 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 have been verified - [ ] New dependencies are appropriate or there were no changes