A note to PR reviewers: it may be helpful to review our
code review documentation
to know what to keep in mind while reviewing pull requests.
Description
Please enter a clear description about your proposed changes and what the
expected outcome(s) is/are from there. If there are complex implementation
details within the changes, this is a great place to explain those details using
plain language.
This should include:
Links to issues that this PR addresses
Screenshots or screen captures of any visible changes, especially for UI work
Dependency changes
If there are any caveats, known issues, follow-up items, etc., make a quick note
of them here as well, though more details are probably warranted in the issue
itself in this case.
TODO (optional)
If you're opening a draft PR, it might be helpful to list any outstanding work,
especially if you're asking folks to take a look before it's ready for full
review. In this case, create a small checklist with the outstanding items:
[ ] TODO item 1
[ ] TODO item 2
[ ] TODO item ...
Security Considerations
Please think about the security compliance aspect of your changes and what the
potential impacts might be.
NOTE: Please be mindful of sharing sensitive information here! If you're not
sure of what to write, please ask the team first before writing anything here.
Relevant details could include (and are not limited to) the following:
Handling secrets/credential management (or specifically calling out that there
is nothing to handle)
Any adjustments to the flow of data in and out the system, or even within it
Connecting or disconnecting any external services to the application
Handling of any sensitive information, such as PII
Handling of information within log statements or other application monitoring
services/hooks
The inclusion of a new external dependency or the removal of an existing one
... (anything else relevant from a security compliance perspective)
There are some cases where there are no security considerations to be had, e.g.,
updating our documentation with publicly available information. In those cases
it is fine to simply put something like this:
None; this is a documentation update with publicly available information.
A note to PR reviewers: it may be helpful to review our code review documentation to know what to keep in mind while reviewing pull requests.
Description
Please enter a clear description about your proposed changes and what the expected outcome(s) is/are from there. If there are complex implementation details within the changes, this is a great place to explain those details using plain language.
This should include:
If there are any caveats, known issues, follow-up items, etc., make a quick note of them here as well, though more details are probably warranted in the issue itself in this case.
TODO (optional)
If you're opening a draft PR, it might be helpful to list any outstanding work, especially if you're asking folks to take a look before it's ready for full review. In this case, create a small checklist with the outstanding items:
Security Considerations
Please think about the security compliance aspect of your changes and what the potential impacts might be.
NOTE: Please be mindful of sharing sensitive information here! If you're not sure of what to write, please ask the team first before writing anything here.
Relevant details could include (and are not limited to) the following:
There are some cases where there are no security considerations to be had, e.g., updating our documentation with publicly available information. In those cases it is fine to simply put something like this: