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

docs: add section in contribution guidelines describing fixup commits

Browse Source
This commit is contained in:
Olaoluwa Osuntokun 2018-12-12 19:10:34 -08:00
parent d1571badaf
commit ce39910f96
No known key found for this signature in database
GPG Key ID: CE58F7F8E20FD9A2
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/code_contribution_guidelines.md
View File

@ -560,6 +560,13 @@ master. In certain cases the code reviewer(s) or interested committers may help
you rework the code, but generally you will simply be given feedback for you to
make the necessary changes.
During the process of responding to review comments, we prefer that changes be
made with [fixup commits](https://robots.thoughtbot.com/autosquashing-git-commits).
The reason for this is two fold: it makes it easier for the reviewer to see
what changes have been made between versions (since Github doesn't easily show
prior versions like Critique) and it makes it easier on the PR author as they
can set it to auto squash the fix up commits on rebase.
This process will continue until the code is finally accepted.
<a name="CodeAcceptance" />