Peer review check-list
These are the things I have picked up from peer-reviewing issues. They can also be applied when solving issues. If you can think of anything that needs to be added, please do so.
Syntax
Ensure that:
- there are no unnecessary blank lines in the new code;
- blank lines do not contain spaces;
- variables are named correctly (all lower case, no underscores);
- functions are named correctly; and
- there are no unnecessary changes to whitespace in other areas on the file.
See the Coding style guide for details.
Output
Ensure that:
- the code doesn't use buffered output unless absolutely necessary; and
- lang-strings are used instead of hard-coded strings for text output.
Databases
If there is SQL code you can test quickly, do so.
Ensure that:
- there are minimal DB calls (no excessive use of the DB); and
- the code uses SQL compatible with all the supported DB engines.
Misc
Ensure that:
- the code seems to solve the described problem;
- there are specific testing instructions that state how, as well as what, to test;
- the code doesn't use deprecated functions (see Deprecated functions in 2.0);
- the code makes sense in the broader scheme of things (look at the whole function, not just the altered code); and
- the code is easy to understand, and where it isn't, comments have been provided.
