14 lines
429 B
Markdown
14 lines
429 B
Markdown
|
# How to write a good pull request
|
||
|
|
|
||
|
|
- Make it small
|
||
|
|
- Do only one thing
|
||
|
|
- Avoid re-formatting
|
||
|
|
- Make sure the code builds
|
||
|
|
- Make sure all tests pass
|
||
|
|
- Add tests
|
||
|
|
- Write useful descriptions and titles
|
||
|
|
- Address review comments in terms of additional commits.
|
||
|
|
- Do not amend/squash existing ones unless the PR is trivial.
|
||
|
|
|
||
|
|
Read [10 tips for better pull requests](http://blog.ploeh.dk/2015/01/15/10-tips-for-better-pull-requests/).
|