From 5ef263455c4a2b4cbf1ef75e9c3db847827f943e Mon Sep 17 00:00:00 2001 From: jimmyfagan <90421499+jimmyfagan@users.noreply.github.com> Date: Wed, 17 Jul 2024 16:37:23 -0500 Subject: [PATCH] First pass of PR template updates (#1223) --- .github/pull_request_template.md | 70 ++++++-------------------------- 1 file changed, 13 insertions(+), 57 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 3a8634514..0403be079 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -7,12 +7,8 @@ This PR template is here to help ensure you're setup for success: **JIRA Ticket:** [BB2-XXXX](https://jira.cms.gov/browse/BB2-XXXX) -**User Story or Bug Summary:** - - ### What Does This PR Do? - +Replace me. ### What Should Reviewers Watch For? - -If you're reviewing this PR, please check these things, in particular: +If you're reviewing this PR, please check for these things in particular: + -* TODO +### Validation + ### What Security Implications Does This PR Have? -Submitters should complete the following questionnaire: - -* If the answer to any of the questions below is **Yes**, then here's a link to the associated Security Impact Assessment (SIA), security checklist, or other similar document in Confluence: N/A. - * Does this PR add any new software dependencies? **Yes** or **No**. - * Does this PR modify or invalidate any of our security controls? **Yes** or **No**. - * Does this PR store or transmit data that was not stored or transmitted before? **Yes** or **No**. -* If the answer to any of the questions below is **Yes**, then please add a Security Engineer and ISSO as a reviewer, and note that this PR should not be merged unless/until he also approves it. - * Do you think this PR requires additional review of its security implications for other reasons? **Yes** or **No**. - - -### What Needs to Be Merged and Deployed Before this PR? - - +* Adds any new software dependencies +* Modifies any security controls +* Adds new transmission or storage of data +* Any other changes that could possibly affect security? -This PR cannot be either merged or deployed until the following pre-requisite changes have been fully deployed: +* [ ] Yes, one or more of the above security implications apply. This PR must not be merged without the ISSO or team security engineer's approval. -* CMSgov/some_repo#42 ### Any Migrations? @@ -83,31 +67,3 @@ Make sure to work with whoever is doing the deploy so they are aware of any migr * [ ] The migrations should be run AFTER the code is deployed * [ ] There is a more complicated migration plan (downtime, etc) * [ ] No migrations - - -### Submitter Checklist - - - -I have gone through and verified that...: - -* [ ] This PR is reasonably limited in scope, to help ensure that: - 1. It doesn't unnecessarily tie a bunch of disparate features, fixes, refactorings, etc. together. - 2. There isn't too much of a burden on reviewers. - 3. Any problems it causes have a small "blast radius". - 4. It'll be easier to rollback if that becomes necessary. -* [ ] I have named this PR and its branch such that they'll be automatically be linked to the (most) relevant Jira issue, per: . -* [ ] This PR includes any required documentation changes, including `README` updates and changelog / release notes entries. -* [ ] All new and modified code is appropriately commented, such that the what and why of its design would be reasonably clear to engineers, preferably ones unfamiliar with the project. -* [ ] All tech debt and/or shortcomings introduced by this PR are detailed in `TODO` and/or `FIXME` comments, which include a JIRA ticket ID for any items that require urgent attention. -* [ ] Reviews are requested from both: - * At least two other engineers on this project, at least one of whom is a senior engineer or owns the relevant component(s) here. - * Any relevant engineers on other projects (e.g. BFD, SLS, etc.). -* [ ] Any deviations from the other policies in the [DASG Engineering Standards](https://github.com/CMSgov/cms-oeda-dasg/blob/master/policies/engineering_standards.md) are specifically called out in this PR, above. - * Please review the standards every few months to ensure you're familiar with them.