CodeReview

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 (with and without MPI) 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
   5. Conforms to coding standards
3. Any new files must contain up-to-date copyright and license text.
4. Check that the example mini-app (finite_difference/example) compiles (both serial and parallel) and is valgrind-clean when run. See the 'test' target in the associated Makefile.

Once we have documentation then this will also need to be checked.