docs: update contribution guidelines with new merge commit policy

This commit is contained in:
Olaoluwa Osuntokun
2018-12-12 19:12:05 -08:00
parent a76affae91
commit 49da4a60aa

View File

@@ -573,11 +573,14 @@ This process will continue until the code is finally accepted.
#### 5.3. Acceptance #### 5.3. Acceptance
Once your code is accepted, it will be integrated with the master branch. Once your code is accepted, it will be integrated with the master branch. After
Typically it will be rebased and fast-forward merged to master as we prefer to 2+ (sometimes 1) LGTM's (approvals) are given on a PR, it's eligible to land in
keep a clean commit history over a tangled weave of merge commits. However, master. At this final phase, it may be necessary to rebase the PR in order to
regardless of the specific merge method used, the code will be integrated with resolve any conflicts and also squash fix up commits. Ideally, the set of
the master branch and the pull request will be closed. [commits by new contributors are PGP signed](https://git-scm.com/book/en/v2/Git-Tools-Signing-Your-Work),
although this isn't a strong requirement (but we prefer it!). In order to keep
these signatures intact, we prefer using merge commits. PR proposers can use
`git rebase --signoff` to sign and rebase at the same time as a final step.
Rejoice as you will now be listed as a [contributor](https://github.com/lightningnetwork/lnd/graphs/contributors)! Rejoice as you will now be listed as a [contributor](https://github.com/lightningnetwork/lnd/graphs/contributors)!