Skip to content

Latest commit

 

History

History
59 lines (39 loc) · 2.87 KB

PULL_REQUEST_REVIEW_CHECKLIST.md

File metadata and controls

59 lines (39 loc) · 2.87 KB
Raw

This is the checklist that all PR are going through, so as a potential contributor it is probably a good idea to check it by yourself.

General

  • Is this change useful to me, or something that I think will benefit others greatly?
  • Check for overlap with other PRs.
  • Think carefully about the long-term implications of the change. How will it affect existing projects that are dependent on this? How will it affect my projects? If this is complicated, do I really want to maintain it forever? Is there any way it could be implemented as a separate package, for better modularity and flexibility?
  • Am I the original author of this PR? Pull requests that are taken from other authors and refactored are going to be refused.

Check the Code

  • If it does too much, ask for it to be broken up into smaller PRs.
  • Does it pass flake8?
  • Have you run black on your code to comply with code formatting rules (https://black.readthedocs.io/en/stable/)?
  • Is it consistent?
  • Review the changes carefully, line by line. Make sure you understand every single part of every line. Learn whatever you do not know yet.
  • Take the time to get things right. PRs almost always require additional improvements to meet the bar for quality. Be very strict about quality. This usually takes several commits on top of the original PR.

Check the Tests

  • Does it have tests? If not:

    • Comment on the PR "Can you please add tests for this code to test_blah.py", or...
    • Write the tests yourself.

  • Do the tests pass for all of the following? If not, write a note in the PR, or fix them yourself.

    • Python 3.6 - Windows
    • Python 3.6 - Mac
    • Python 3.6 - Linux

Check the Docs

  • Does it have docs? If not:

    • Comment on the PR "Can you please add docs for this feature to docs/usage.rst", or...
    • Write the docs yourself.

  • If any new functions/classes are added, do they contain docstrings?

  • If any new features are added, are they in README.rst?

Credit the Authors

  • Add name and URL to AUTHORS.rst.
  • Copy and paste title and PR number into HISTORY.rst.
  • Thank them for their hard work.

That list is heavily inspired of https://gist.githubusercontent.com/audreyr/4feef90445b9680475f2/raw/b71e765f35a828cedd0c6dbd0f01f4f2a0c5eb12/pull-request-review-checklist.md.

Close Issues

  • Merge the PR branch. This will close the PR's issue.
  • Close any duplicate or related issues that can now be closed. Write thoughtful comments explaining how the issues were resolved.

Release (optional)

  • Decide whether the changes in master make sense as a major, minor, or patch release.
  • Look at the clock. If you're tired, release later when you have time to deal with release problems.
  • Then follow all the steps in Audreyr PyPI Release Checklist