Code Review

Owned by Gildas Lanilis Gmail
Last updated: Oct 11, 2017 by Michael O'Brien
1 min read

The simple way intended to find mistakes overlooked in the initial development phase.
The goal is to improve overall quality of the code .
Practices vary from pair programming, informal walkthroughs, and formal inspection.
ONAP uses Gerrit for Code Review 
What to review?

  1. Comply to Coding Guidelines: see Java code style
  2. Comply to Intellectual Property (Copyright and license headers)
  3. Comply with Commit Process
  4. Ensure there is no Chinese Character in comments

Code reviews are expected to take place within the next 36 business hours after the code has been submitted within Gerrit.

ONAP is an Open Source project and thus anyone who is interested can provide code review.

Best candidate to ensure the code is reviewed are the “Committers” listed in project resources.

Authors are not expected to perform Code Review on their own code.  This rule is especially true for integration work.


See also Committer Best Practices

Rules

Mandatory for all projects, whatever their state.

Self-commits are not allowed

All Commits must be reviewed and integration tested.

Depending on the project state, there is a variable depending on the % of committers to perform code review

Feedback provided by voting "-1" (issue), "0" (ok, neutral, abstain), "+1" (approve)

  • Incubation: “+1” from 30% of committers (min: 2); no “-1”
  • Mature: “+1” from 60% of committers; no “-1”
  • Core: “+1” from 75% of committers; no “-1”

The code should not be accepted if there are open issues, but should as soon as the minimum threshold of reviews have come in.