Skip to content

Latest commit

 

History

History
36 lines (23 loc) · 1.44 KB

PULL_REQUEST_TEMPLATE.md

File metadata and controls

36 lines (23 loc) · 1.44 KB
Raw

START OF ARCH PR GUIDE -- DELETE THIS SECTION BEFORE OPENING PR

Please familiarize yourself with the Contributing guide BEFORE submitting a PR.

Here's a summarized TL;DR -

  1. Pass tests and validate style (linting) as you develop
  2. Write new tests for new functions. Improve old tests!
  3. Keep your PR small. Separate it by issue if you need to.
  4. Update RELEASE.md notes
  5. Be as descriptive as possible in the PR description.
  6. Use git tools to manage review flow (resolve comments, re-request)
  7. Clean up commits and merge

We will start closing PRs that skip steps and asking them to be resubmitted properly.

END OF ARCH PR GUIDE -- DELETE SECTION BEFORE OPENING PR

Overview & Major Changes

Please summarize this PR. Include references to other issues or epics that this ticket addresses.

You might also include a highlight reel of the complex or unclear changes, if any. Some examples might be:

  • This PR adds the functionality to parse encrypted packets. The new function signatures can be found in "blah"

  • We chose to use the {packageName} package because {reasons}.

Additional Notes

Optional section to include more information. This might include things that you ruled out, or testing/alternatives. Since PR text is searchable, we can retain some knowledge about past decisions that were made -- but only if we write it down!