docs: expand contributor checklist w/ commit structure

This commit is contained in:
Olaoluwa Osuntokun 2018-12-19 17:02:25 -08:00
parent 49da4a60aa
commit af306e2360
No known key found for this signature in database
GPG Key ID: CE58F7F8E20FD9A2
2 changed files with 10 additions and 0 deletions

View File

@ -1,5 +1,7 @@
#### Pull Request Checklist
- [ ] If this is your first time contributing, we recommend you read the [Code
Contribution Guidelines](https://github.com/lightningnetwork/lnd/blob/master/docs/code_contribution_guidelines.md)
- [ ] All changes are Go version 1.11 compliant
- [ ] The code being submitted is commented according to the
[Code Documentation and Commenting](#CodeDocumentation) section
@ -17,3 +19,7 @@
- [ ] Running `go vet` does not report any issues
- [ ] Running `make lint` does not report any **new** issues that did not
already exist
- [ ] All commits build properly and pass tests. Only in exceptional
cases it can be justifiable to violate this condition. In that case, the
reason should be stated in the commit message.
- [ ] Commits have a logical structure ([see section 4.5, of the Code Contribution Guidelines])

View File

@ -609,6 +609,10 @@ Rejoice as you will now be listed as a [contributor](https://github.com/lightnin
- [  ] Running `go vet` does not report any issues
- [  ] Running `make lint` does not report any **new** issues that
did not already exist
- [  ] All commits build properly and pass tests. Only in exceptional
cases it can be justifiable to violate this condition. In that case, the
reason should be stated in the commit message.
- [  ] Commits have a logical structure (see section 4.5).
<a name="Licensing" />