| | 12 | |
| | 13 | == Code Reviews == |
| | 14 | Code review is a pretty simple process: at its heart, it is little more than reading some code written by someone else. Nevertheless, it can be useful to have a set of things on which to focus during a review: |
| | 15 | |
| | 16 | * Does the branch merge or the diff apply cleanly? |
| | 17 | * Are there unit tests for the code being changed or added? |
| | 18 | * Do the unit tests pass for you? |
| | 19 | * Do the unit tests pass for buildbot? |
| | 20 | * Is there documentation for new code? |
| | 21 | * Where appropriate, has existing documentation been updated (including ChangeLog?/NEWS files)? |
| | 22 | * Does the code adhere to the coding standard? |
| | 23 | |
| | 24 | There's the easy list. Most are mechanical checks. Don't feel bad about rejecting a branch if the answer to any of these questions is no: the problems may seem minor in isolation, but each contributes to overall poor code quality. Moreover, sometimes apparently minor problems can be hiding larger issues. |
