akovalenko/lnd.xprv
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Merge pull request #2830 from philippgille/feature/update-contribution-checklist

Browse Source 
docs: update contribution checklist
This commit is contained in:
Wilmer Paulino 2019-04-05 15:46:34 -07:00 committed by GitHub
commit 73791e15a1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 14 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
.github/pull_request_template.md vendored
View File

@ -2,9 +2,8 @@
- [ ] If this is your first time contributing, we recommend you read the [Code - [ ] 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) Contribution Guidelines](https://github.com/lightningnetwork/lnd/blob/master/docs/code_contribution_guidelines.md)
- [ ] All changes are Go version 1.11 compliant - [ ] All changes are Go version 1.12 compliant
- [ ] The code being submitted is commented according to the - [ ] 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)
[Code Documentation and Commenting](#CodeDocumentation) section
- [ ] For new code: Code is accompanied by tests which exercise both - [ ] For new code: Code is accompanied by tests which exercise both
the positive and negative (error paths) conditions (if applicable) 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
@ -22,4 +21,4 @@
- [ ] All commits build properly and pass tests. Only in exceptional - [ ] All commits build properly and pass tests. Only in exceptional
cases it can be justifiable to violate this condition. In that case, the cases it can be justifiable to violate this condition. In that case, the
reason should be stated in the commit message. 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
docs/code_contribution_guidelines.md
View File

@ -612,9 +612,8 @@ Rejoice as you will now be listed as a [contributor](https://github.com/lightnin
#### 6.1. Contribution Checklist #### 6.1. Contribution Checklist
- [  ] All changes are Go version 1.11 compliant - [  ] All changes are Go version 1.12 compliant
- [  ] The code being submitted is commented according to the - [  ] The code being submitted is commented according to [Code Documentation and Commenting](#CodeDocumentation)
[Code Documentation and Commenting](#CodeDocumentation) section
- [  ] For new code: Code is accompanied by tests which exercise both - [  ] For new code: Code is accompanied by tests which exercise both
the positive and negative (error paths) conditions (if applicable) 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
@ -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 - [  ] All commits build properly and pass tests. Only in exceptional
cases it can be justifiable to violate this condition. In that case, the cases it can be justifiable to violate this condition. In that case, the
reason should be stated in the commit message. 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" /> <a name="Licensing" />