Skip to content

Commit

Permalink
First pass of PR template updates (#1223)
Browse files Browse the repository at this point in the history
  • Loading branch information
jimmyfagan authored Jul 17, 2024
1 parent cf94a91 commit 5ef2634
Showing 1 changed file with 13 additions and 57 deletions.
70 changes: 13 additions & 57 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:**
<!-- Please copy-paste the brief user story or bug description that this PR is intended to address. -->


### What Does This PR Do?

<!--
Add detailed description & discussion of changes here.
The contents of this section should be used as your commit message (unless you merge the PR via a merge commit, of course).
Expand All @@ -26,12 +22,10 @@ Please follow standard Git commit message guidelines:
Reference: <https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project>.
-->

Replace me.

### What Should Reviewers Watch For?

<!--
Add some items to the following list, or remove the entire section if it doesn't apply for some reason.
Common items include:
* Is this likely to address the goals expressed in the user story?
* Are any additional documentation updates needed?
Expand All @@ -41,36 +35,26 @@ Common items include:
* Can you find any bugs if you run the code locally and test it manually?
-->

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:
<!-- Add some items here -->

* TODO
### Validation

<!--
Have you fully verified and tested these changes? Is the acceptance criteria met? Please provide reproducible testing instructions, code snippets, or screenshots as applicable.
-->

### 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?

<!--
Add some items to the following list, or remove the entire section if it doesn't apply.
Please indicate if this PR does any of the following:

Common items include:
* Database migrations (which should always be deployed by themselves, to reduce risk).
* New features in external dependencies (e.g. BFD).
-->
* 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?

Expand All @@ -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) <!-- Make sure to include the details of the plan below -->
* [ ] No migrations


### Submitter Checklist

<!--
Helpful hint: if needed, Git allows you to edit your PR's commits and history, prior to merge.
See these resources for more information:
* <https://dev.to/maxwell_dev/the-git-rebase-introduction-i-wish-id-had>
* <https://raphaelfabeni.com/git-editing-commits-part-1/>
-->

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: <https://confluence.atlassian.com/adminjiracloud/integrating-with-development-tools-776636216.html>.
* [ ] 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.

0 comments on commit 5ef2634

Please sign in to comment.