52
52
53
53
< div id ="entry_block ">
54
54
< div class ="entry ">
55
- < div class ="date "> Last updated: 24 April 2020</ div >
55
+ < div class ="date "> Last updated: 17 May 2020</ div >
56
56
< div class ="body ">
57
57
< article >
58
58
< div class ="title "> How to Review Pull Requests in Bitcoin Core</ div >
@@ -716,6 +716,13 @@ <h4 id="peer-review">Peer review</h4>
716
716
< a href ="https://github.com/bitcoin/bitcoin/pull/16149 "> updated</ a > ,
717
717
so refer back to it frequently.
718
718
</ p >
719
+ < p >
720
+ An ACK is generally followed by a description of how the
721
+ reviewer did the review and any manual testing. As a new
722
+ contributor, it's advisable to be even more verbose in review
723
+ comments to provide context on what you did and thought through
724
+ during the review.
725
+ </ p >
719
726
< p >
720
727
Concept ACK means the reviewer acknowledges and agrees with the
721
728
goal of the change, but is not (yet) confirming they've looked
@@ -730,6 +737,18 @@ <h4 id="peer-review">Peer review</h4>
730
737
implementing the change. Approach NACK would therefore indicate
731
738
agreement with the goal but not the approach.
732
739
</ p >
740
+ < p >
741
+ Sometimes reviewers comment "code review ack" to be specific
742
+ about the fact that the code looks good but they haven't tested
743
+ the changes further or don't have much of an opinion on the
744
+ concept yet. When in doubt, adding more context doesn't hurt,
745
+ e.g. "code review ACK < code > HEAD</ code > , unsure about the
746
+ concept, I'd like to verify x, y, z..."
747
+ </ p >
748
+ < p >
749
+ Other ACK variants that are sometimes used are "tACK" or "tested
750
+ ACK", and "utACK" or "untested ACK".
751
+ </ p >
733
752
< p >
734
753
Manual testing of new features and reported issues is always
735
754
welcome. A comment that is really helpful in review: "Here's
@@ -745,6 +764,12 @@ <h4 id="peer-review">Peer review</h4>
745
764
about behaviour to give an ACK" is a perfectly helpful
746
765
contribution.
747
766
</ p >
767
+ < p >
768
+ Examples of other useful comments could be "verified move-only"
769
+ if the PR includes move-only commits, or "thought hard about how
770
+ change X could break Y but didn't find any (or could this
771
+ scenario happen?)", etc.
772
+ </ p >
748
773
< p >
749
774
When giving an ACK, specify the commits reviewed by appending
750
775
the commit hash of the < code > HEAD</ code > commit. The trustless
@@ -761,10 +786,10 @@ <h4 id="peer-review">Peer review</h4>
761
786
</ p >
762
787
< p >
763
788
The Bitcoin Core merge script currently copies into the merge
764
- commit all ACK comments pertaining to the < code > HEAD </ code >
765
- commit at the time of merge. Keep in mind that anything you
766
- write in an ACK comment that is copied by the merge script will
767
- be in git history forever.
789
+ commit the first line of each ACK review pertaining to
790
+ the < code > HEAD </ code > commit at the time of merge. Keep in mind
791
+ that anything you write there that is copied by the merge script
792
+ will be in git history forever.
768
793
</ p >
769
794
< p >
770
795
A complex PR usually requires at least 3-4 experienced ACKs
0 commit comments