Jump to: navigation, search

Fuel/Code Review Rules

< Fuel
Revision as of 02:12, 3 June 2014 by Dmitry Borodaenko (talk | contribs) (Submitting your code for review)

Why do we need code review?

Code review is essential to sustainable software development process. It serves the following goals:

  1. Confirm that proposed code change is suitable for its purpose: it solves the stated problem and follows the agreed architecture.
  2. Analyze external impact of the code change: it doesn't introduce new issues, doesn't reduce stability and performance of the whole solution.
  3. Enforce code quality standards: the proposed change is well structured, well documented, and is consistent with the coding style of the surrounding code.
  4. Spread knowledge about architecture and implementation details, keep other developers up to date with current state of the code base.

Submitting your code for review

  1. Make sure your commit message describes the proposed code change adequately and is in line with commit message guidelines.
  2. Make sure your code improves overall quality of the surrounding code, avoid quick and dirty workarounds, follow code quality standards.
  3. Remember that it is your responsibility to get other developers to review and and approve your commit. Be proactive and responsive, use IRC and mailing list to draw attention of core developers to your review requests, and try to address all review comments promptly.

Reviewing other people's code

Commit message guidelines

Code quality standards