Skip to content
This repository was archived by the owner on Jan 23, 2024. It is now read-only.

Code review process

Simon Lynen edited this page Feb 23, 2014 · 10 revisions

Code Review and Continuous Integration

Every code change – even one liners – have to be reviewed! Switch to a new branch away from master. e.g.

git checkout -b feature/map_database_serialization

Work on your changes, try to keep them concise.

  • Try to not commit code that does not build.
  • < 1000 lines per change-list.
  • Commit liberally.

Test and verify your changes.

  • Use gTest (see below), try to test also less common cases.
  • Think about wrong inputs to your methods and try to catch them.

Code review process (overview)

  • Issue a pull-request on github: creating-a-pull-request
  • Ask your co-students and supervisor to review the code.
  • Look for memory-leaks, algorithmic errors, inefficiencies
  • You can learn a lot from this, as reviewer and as reviewed person
  • Iterate on the review comments.
  • Your supervisor will approve your changes.
  • Make sure your latest change is successfully tested by the build-server (if available).
  • Merge the branch to master by hitting the merge button.
Clone this wiki locally