doc: enhance GitHub template.
- add issue and PR guide. - rewrite templates
This commit is contained in:
parent
4f2a2d573d
commit
ccff8a80f5
6 changed files with 101 additions and 21 deletions
13
.github/how-to-write-a-good-pull-request.md
vendored
Normal file
13
.github/how-to-write-a-good-pull-request.md
vendored
Normal file
|
@ -0,0 +1,13 @@
|
|||
# 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/).
|
Loading…
Add table
Add a link
Reference in a new issue