Skip to content

Commit d79967c

Browse files
authored
Merge pull request #12 from CMSgov/ajones/BB2-1391-add-reviewer-checklist-to-PR-template
[ BB2-1391 ] add reviewer checklist to SDK
2 parents 6c17f13 + 03f3dad commit d79967c

File tree

1 file changed

+49
-0
lines changed

1 file changed

+49
-0
lines changed

.github/pull_request_template.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,3 +43,52 @@ Common items include:
4343
If you're reviewing this PR, please check these things, in particular:
4444

4545
- TODO
46+
47+
### What Security Implications Does This PR Have?
48+
49+
Submitters should complete the following questionnaire:
50+
51+
- 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.
52+
- Does this PR add any new software dependencies? **Yes** or **No**.
53+
- Does this PR modify or invalidate any of our security controls? **Yes** or **No**.
54+
- Does this PR store or transmit data that was not stored or transmitted before? **Yes** or **No**.
55+
- If the answer to any of the questions below is **Yes**, then please add StewGoin as a reviewer, and note that this PR should not be merged unless/until he also approves it.
56+
- Do you think this PR requires additional review of its security implications for other reasons? **Yes** or **No**.
57+
58+
### What Needs to Be Merged and Deployed Before this PR?
59+
60+
<!--
61+
Add some items to the following list, or remove the entire section if it doesn't apply.
62+
63+
Common items include:
64+
* New features in external dependencies (e.g. BB2-API).
65+
-->
66+
67+
This PR cannot be either merged or deployed until the following pre-requisite changes have been fully deployed:
68+
69+
- CMSgov/some_repo#42
70+
71+
<!--
72+
Helpful hint: if needed, Git allows you to edit your PR's commits and history, prior to merge.
73+
See these resources for more information:
74+
75+
* <https://dev.to/maxwell_dev/the-git-rebase-introduction-i-wish-id-had>
76+
* <https://raphaelfabeni.com/git-editing-commits-part-1/>
77+
-->
78+
79+
I have gone through and verified that...:
80+
81+
- [ ] This PR is reasonably limited in scope, to help ensure that:
82+
1. It doesn't unnecessarily tie a bunch of disparate features, fixes, refactorings, etc. together.
83+
2. There isn't too much of a burden on reviewers.
84+
3. Any problems it causes have a small "blast radius".
85+
4. It'll be easier to rollback if that becomes necessary.
86+
- [ ] 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>.
87+
- [ ] This PR includes any required documentation changes, including `README` updates and changelog / release notes entries.
88+
- [ ] 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.
89+
- [ ] 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.
90+
- [ ] Reviews are requested from both:
91+
- At least two other engineers on this project, at least one of whom is a senior engineer or owns the relevant component(s) here.
92+
- Any relevant engineers on other projects (e.g. BFD, SLS, etc.).
93+
- [ ] 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.
94+
- Please review the standards every few months to ensure you're familiar with them.

0 commit comments

Comments
 (0)