Skip to content

pull_request_template.md

Latest commit

 

History

History
29 lines (20 loc) · 1.42 KB

pull_request_template.md

File metadata and controls

29 lines (20 loc) · 1.42 KB
Raw

Enhancement, Feature or Issue: [Edit this description and all other fields in square brackets]

Specialized PR templates can be given in the URL used to create the PR.

If this PR is to fix a bug, add template=bug_fix.md to the query string at the end of the URL used to get to this page. To use the specialized Feature template, add template=feature.md. Example: https://github.com/sprax/cpp/compare/fixify?expand=1&template=bug_fix.md

(GitHub does not yet support multiple pull-request templates as well as it does issue templates.)

  • [What does it do? Issues in thie repo can be added as #N. Others need the full link.]
  • Feature has unit and/or system tests [or reason that does not apply, e.g., only the README changed]
  • Feature documented in code (Doxygen-style comments in headers).
  • Feature demonstrated in context [or reason that does not apply, e.g., ONLY a test changed].

PR's that this one needs -- Check this box only after they are all merged:

  • [Add links to any PR's this one requires to go in first, or delete this.]

PR's that need this one -- Check this box only after they are ready and reviewed:

  • [Add links to any PR's that require this one to go in first, or delete this.]

Platform

  • [Test any other downstream package that may be affected.]
  • Code format: Is it readable? Will the PR diffs annoy reviewers?

TODOs / Nice-To-Haves:

  • [Edit or delete this list as appropriate.]