gatk-3.8/.github/PULL_REQUEST_TEMPLATE.md

1.4 KiB

Description

Please explain the changes you made here. Explain the motivation for making this change. What existing problem does the pull request solve? Mention any issues fixed, addressed or otherwise related to this pull request, including issue numbers or hard links for issues in other repos.


Checklist (never delete this)

Never delete this, it is our record that procedure was followed. If you find that for whatever reason one of the checklist points doesn't apply to your PR, you can leave it unchecked but please add an explanation below.

Content

  • Added or modified tests to cover changes and any new functionality
  • All tests passing on Bamboo (including license tests!)

Form

  • Rebased, squashed and reworded to produce a single commit (exemptions may be made -- sparingly) that is uncluttered by excess lines (lines that just say "addressed review", "fixed" etc left over from squashing)
  • Both the PR and the final rebased commit have a concise yet descriptive title (they are used when we compile version notes)
  • Edited the README / documentation accordingly and got sign-off from support team (private code is exempt)

Review

  • Suggest a reviewer or ask your team lead to suggest one
  • Final (thumbsup) from the reviewer(s)

Once everything is checked off, you can go ahead and merge the PR. Don't forget to also delete the branch.