From af306e236079c4970d673954692165144848b37d Mon Sep 17 00:00:00 2001 From: Olaoluwa Osuntokun Date: Wed, 19 Dec 2018 17:02:25 -0800 Subject: [PATCH] docs: expand contributor checklist w/ commit structure --- .github/pull_request_template.md | 6 ++++++ docs/code_contribution_guidelines.md | 4 ++++ 2 files changed, 10 insertions(+) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 2ca61829..90f47ff8 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -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]) diff --git a/docs/code_contribution_guidelines.md b/docs/code_contribution_guidelines.md index 73f3861b..1d06b5a7 100644 --- a/docs/code_contribution_guidelines.md +++ b/docs/code_contribution_guidelines.md @@ -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).