darkhelm/notifications-api
1
0
Fork 0
mirror of https://github.com/GSA/notifications-api.git synced 2026-02-05 02:41:14 -05:00
Code Issues Packages Projects Releases Wiki Activity

Final draft adjustments to the template instructions

Browse Source 
Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
This commit is contained in:
Carlo Costino
2024-02-09 17:40:14 -05:00
parent 050d92d822
commit 6e6c0ee61d
1 changed files with 9 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
.github/pull_request_template.md vendored
View File

@@ -5,6 +5,7 @@ have all of the relevant details needed for our work.
At the minimum, please be sure to fill in all sections found below and also do At the minimum, please be sure to fill in all sections found below and also do
the following: the following:
- Provide an appropriate and descriptive title for the pull request
- Link the pull request to its corresponding issue (must be done after creating - Link the pull request to its corresponding issue (must be done after creating
the pull request itself) the pull request itself)
- Assign yourself as the author - Assign yourself as the author
@@ -13,13 +14,17 @@ the following:
- Select one or more reviewers from the team or mark the pull request as a draft - Select one or more reviewers from the team or mark the pull request as a draft
depending on its current state depending on its current state
- If the pull request is a draft, please be sure to add reviewers once it is - If the pull request is a draft, please be sure to add reviewers once it is
ready for review ready for review and mark it ready for review
For each section, please delete the instructions/sample (text that includes this For each section, please delete the instructions/sample text (that includes this
text, though it is wrapped in an HTML comment just in case) and put in your own text, though it is wrapped in an HTML comment just in case) and put in your own
information. Thank you! information. Thank you!
--> -->
*A note to PR reviewers: it may be helpful to review our
[code review documentation](https://github.com/GSA/notifications-api/blob/main/docs/all.md#code-reviews)
to know what to keep in mind while reviewing pull requests.*
## Description ## Description
Please enter a clear description about your proposed changes and what the Please enter a clear description about your proposed changes and what the
@@ -30,7 +35,7 @@ plain language.
This should include: This should include:
- Links to issues that this PR addresses - Links to issues that this PR addresses
- Screenshots of any visible changes - Screenshots or screen captures of any visible changes, especially for UI work
- Dependency changes - Dependency changes
If there are any caveats, known issues, follow-up items, etc., make a quick note If there are any caveats, known issues, follow-up items, etc., make a quick note
@@ -64,7 +69,7 @@ Relevant details could include (and are not limited to) the following:
- Handling of any sensitive information, such as PII - Handling of any sensitive information, such as PII
- Handling of information within log statements or other application monitoring - Handling of information within log statements or other application monitoring
services/hooks services/hooks
- The inclusion of a new external dependency - The inclusion of a new external dependency or the removal of an existing one
- ... (anything else relevant from a security compliance perspective) - ... (anything else relevant from a security compliance perspective)
There are some cases where there are no security considerations to be had, e.g., There are some cases where there are no security considerations to be had, e.g.,