Skip to content

Instantly share code, notes, and snippets.

@lpil

lpil/pull-request-guidelines.md

Created April 9, 2017 15:59
Show Gist options
  • Save lpil/78e4f35a91ae366b048135e01555a100 to your computer and use it in GitHub Desktop.
Save lpil/78e4f35a91ae366b048135e01555a100 to your computer and use it in GitHub Desktop.
Download ZIP
Raw
pull-request-guidelines.md

Pull Request Guidelines

Good code is tested, designed for change, easy to understand and able to cope when things go wrong.

Good pull requests are descriptive, small and short-lived.

For the Author

  • Description explains what you have done and why.
  • Tests have been written (or you have explained why you don't need tests).
  • Documentation/comments have been added/updated.

For the Reviewer

  • The code is well-designed and able to cope with change.
  • The code is easy to understand.
  • Tests cover happy and unhappy paths in the code.
  • Tests are green on CI (or pulled/tested on your machine).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment