Skip to content

Commit

Permalink
Merge pull request #2830 from philippgille/feature/update-contributio…
Browse files Browse the repository at this point in the history
…n-checklist

docs: update contribution checklist
  • Loading branch information
wpaulino committed Apr 5, 2019
2 parents 25d2b1b + dd3f48e commit 73791e1
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 16 deletions.
23 changes: 11 additions & 12 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,23 @@

- [ ] 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
- [ ] For new code: Code is accompanied by tests which exercise both
- [ ] All changes are Go version 1.12 compliant
- [ ] The code being submitted is commented according to [Code Documentation and Commenting](https://github.com/lightningnetwork/lnd/blob/master/docs/code_contribution_guidelines.md#CodeDocumentation)
- [ ] For new code: Code is accompanied by tests which exercise both
the positive and negative (error paths) conditions (if applicable)
- [ ] For bug fixes: Code is accompanied by new tests which trigger
- [ ] For bug fixes: Code is accompanied by new tests which trigger
the bug being fixed to prevent regressions
- [ ] Any new logging statements use an appropriate subsystem and
- [ ] Any new logging statements use an appropriate subsystem and
logging level
- [ ] Code has been formatted with `go fmt`
- [ ] For code and documentation: lines are wrapped at 80 characters
- [ ] Code has been formatted with `go fmt`
- [ ] For code and documentation: lines are wrapped at 80 characters
(the tab character should be counted as 8 characters, not 4, as some IDEs do
per default)
- [ ] Running `make check` does not fail any tests
- [ ] Running `go vet` does not report any issues
- [ ] Running `make lint` does not report any **new** issues that did not
- [ ] Running `make check` does not fail any tests
- [ ] 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])
- [ ] Commits have a logical structure according to [Ideal Git Commit Structure](https://github.com/lightningnetwork/lnd/blob/master/docs/code_contribution_guidelines.md#IdealGitCommitStructure)
7 changes: 3 additions & 4 deletions docs/code_contribution_guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -612,9 +612,8 @@ Rejoice as you will now be listed as a [contributor](https://github.com/lightnin
#### 6.1. Contribution Checklist
- [  ] All changes are Go version 1.11 compliant
- [  ] The code being submitted is commented according to the
[Code Documentation and Commenting](#CodeDocumentation) section
- [  ] All changes are Go version 1.12 compliant
- [  ] The code being submitted is commented according to [Code Documentation and Commenting](#CodeDocumentation)
- [  ] For new code: Code is accompanied by tests which exercise both
the positive and negative (error paths) conditions (if applicable)
- [  ] For bug fixes: Code is accompanied by new tests which trigger
Expand All @@ -632,7 +631,7 @@ Rejoice as you will now be listed as a [contributor](https://github.com/lightnin
- [  ] 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).
- [  ] Commits have a logical structure according to [Ideal Git Commit Structure](#IdealGitCommitStructure).
<a name="Licensing" />
Expand Down

0 comments on commit 73791e1

Please sign in to comment.