Skip to content

Instantly share code, notes, and snippets.

@peterfpeterson

peterfpeterson/PULL_REQUEST_TEMPLATE.md

Last active February 22, 2016 14:44
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save peterfpeterson/1a451650f57f6b7abd44 to your computer and use it in GitHub Desktop.
Save peterfpeterson/1a451650f57f6b7abd44 to your computer and use it in GitHub Desktop.
Download ZIP
Pull request template
Raw
PULL_REQUEST_TEMPLATE.md

Description of work.

To test: Instructions for testing.

Fixes #xxxx.

Either link to Release notes change-set or state "Does not need to be in the release notes."

Reviewer

Please comment on the following (full description):

Code Review
  • Is the code of an acceptable quality?
    • Does the code conform to the coding standards? Is it well structured with small focussed classes/methods/functions?
    • Are there unit/system tests in place? Are the unit tests small and test the a class in isolation?
Functional Tests

  • Do changes function as described? Add comments below that describe the tests performed?

    • How do the changes handle unexpected situations, e.g. bad input?

  • Has the relevant documentation been added/updated?

    • Is user-facing documentation written in a user-friendly manner?
    • Has developer documentation been updated if required?

  • Does everything look good? Comment with the ship it emoji but don't merge. A member of @mantidproject/gatekeepers will take care of it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment