Skip to content

Commit 73791e1

Browse files
authored
Merge pull request #2830 from philippgille/feature/update-contribution-checklist
docs: update contribution checklist
2 parents 25d2b1b + dd3f48e commit 73791e1

File tree

2 files changed

+14
-16
lines changed

2 files changed

+14
-16
lines changed

.github/pull_request_template.md

+11-12
Original file line numberDiff line numberDiff line change
@@ -2,24 +2,23 @@
22

33
- [ ] If this is your first time contributing, we recommend you read the [Code
44
Contribution Guidelines](https://github.com/lightningnetwork/lnd/blob/master/docs/code_contribution_guidelines.md)
5-
- [ ] All changes are Go version 1.11 compliant
6-
- [ ] The code being submitted is commented according to the
7-
[Code Documentation and Commenting](#CodeDocumentation) section
8-
- [ ] For new code: Code is accompanied by tests which exercise both
5+
- [ ] All changes are Go version 1.12 compliant
6+
- [ ] 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)
7+
- [ ] For new code: Code is accompanied by tests which exercise both
98
the positive and negative (error paths) conditions (if applicable)
10-
- [ ] For bug fixes: Code is accompanied by new tests which trigger
9+
- [ ] For bug fixes: Code is accompanied by new tests which trigger
1110
the bug being fixed to prevent regressions
12-
- [ ] Any new logging statements use an appropriate subsystem and
11+
- [ ] Any new logging statements use an appropriate subsystem and
1312
logging level
14-
- [ ] Code has been formatted with `go fmt`
15-
- [ ] For code and documentation: lines are wrapped at 80 characters
13+
- [ ] Code has been formatted with `go fmt`
14+
- [ ] For code and documentation: lines are wrapped at 80 characters
1615
(the tab character should be counted as 8 characters, not 4, as some IDEs do
1716
per default)
18-
- [ ] Running `make check` does not fail any tests
19-
- [ ] Running `go vet` does not report any issues
20-
- [ ] Running `make lint` does not report any **new** issues that did not
17+
- [ ] Running `make check` does not fail any tests
18+
- [ ] Running `go vet` does not report any issues
19+
- [ ] Running `make lint` does not report any **new** issues that did not
2120
already exist
2221
- [ ] All commits build properly and pass tests. Only in exceptional
2322
cases it can be justifiable to violate this condition. In that case, the
2423
reason should be stated in the commit message.
25-
- [ ] Commits have a logical structure ([see section 4.5, of the Code Contribution Guidelines])
24+
- [ ] Commits have a logical structure according to [Ideal Git Commit Structure](https://github.com/lightningnetwork/lnd/blob/master/docs/code_contribution_guidelines.md#IdealGitCommitStructure)

docs/code_contribution_guidelines.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -612,9 +612,8 @@ Rejoice as you will now be listed as a [contributor](https://github.com/lightnin
612612
613613
#### 6.1. Contribution Checklist
614614
615-
- [  ] All changes are Go version 1.11 compliant
616-
- [  ] The code being submitted is commented according to the
617-
[Code Documentation and Commenting](#CodeDocumentation) section
615+
- [  ] All changes are Go version 1.12 compliant
616+
- [  ] The code being submitted is commented according to [Code Documentation and Commenting](#CodeDocumentation)
618617
- [  ] For new code: Code is accompanied by tests which exercise both
619618
the positive and negative (error paths) conditions (if applicable)
620619
- [  ] For bug fixes: Code is accompanied by new tests which trigger
@@ -632,7 +631,7 @@ Rejoice as you will now be listed as a [contributor](https://github.com/lightnin
632631
- [  ] All commits build properly and pass tests. Only in exceptional
633632
cases it can be justifiable to violate this condition. In that case, the
634633
reason should be stated in the commit message.
635-
- [  ] Commits have a logical structure (see section 4.5).
634+
- [  ] Commits have a logical structure according to [Ideal Git Commit Structure](#IdealGitCommitStructure).
636635
637636
<a name="Licensing" />
638637

0 commit comments

Comments
 (0)