The usual steps for a code review are:
- Author creates a change.
- Author submits one or more patches to Gerrit.
- Author self-reviews the change following the "DOs and DON'Ts" below.
- Author ensures that all tests pass.
- Author adds reviewers and votes +1 on the change (indicating that the change is ready for review).
- Reviewer reviews the change and adds comments and/or votes +2 on the change.
- If the reviewer adds comments and does not vote +2, the author
- addresses each comment by either answering a question, changing the code, or explaining the code should not be changed and
- goes back to step 2 submitting the changed code and/or replies.
- If the reviewer votes +2, the author merges the change.
DOs and DON'Ts
Code reviews take a significant amount of time in terms of effort spent by the reviewer and the latency incurred by waiting on reviews.
By following a few simple rules we can improve the review experience and turnaround times:
...
-
Do all new classes have the correct license header?
Does the change use any new libraries? Are they accepted by the community?
...
-
Is the code of the change formatted using HyracksFormattingProfile?
-
Are xml files indented correctly? (using 4 spaces with no tabs)
-
Are there any extra white spaces?
-
Are member variables which are not intended to be changed made final?
-
Is logging performed properly (i.e. using log4j with the name set as Class.getName())?
-
Are class & member access as restricted as it can be?
-
Are names of variables and methods meaningful and convey intention?
-
Is logging performed properly (i.e. using log4j with the name set as Class.getName())?
...