Skip to content

Reviewing a Pull request

Steve Crawford edited this page Aug 6, 2018 · 3 revisions

General Guidelines for Reviewing a pull request

  • Does the code following PEP8 with allowed exceptions?
  • Are the naming conventions for object followed?
  • Does all new functionality have docstrings?
  • If the PR closes an issue, does it resolve the matter raised?
  • Does it include a change log entry?

Pull request adding new functionality

  • Has the documentation been updated to include a description of the functionality?

  • Has the documentation been updated to include a description of reference files needed?

  • Has a unit test been added if appropriate?

  • Has a regression test been added if appropriate?

Pull request fixing a bug

  • Has a test been added to catch the bug in the future?