Skip to content

CodeReview

Andy Porter edited this page May 2, 2018 · 6 revisions

Guidelines for Performing a Code Review

Before a pull request can be merged to master it must pass a code review. The rules for a code review are as follows:

  1. Branch must compile without compiler warnings
  2. Reviewer must examine the code changes (using the 'diff' tab on the PR) and check that any new code is:
    1. Correct
    2. Well commented
    3. As easy to understand as possible
    4. Documented using Doxygen markup
Clone this wiki locally