In the KIELER project we are conducting regular code reviews of (possibly) all of our sources. To make things easier, we do software assisted reviews in Crucible.
Reviews are scheduled for every thursday. In the weekly KIELER meeting one author and two reviewers are chosen.
The author's job is then to do as follows:
Now it is the reviewers's turn to perform the review:
The week after, on Thursday, the review meeting takes place. In the Meeting the following exciting things happen
After the review it is up to the author to finish any tasks that have been risen
When classes are ready for a design review, they should be marked with the following tag:
@kieler.design proposed <comment> |
After the design review has been performed, the same tag can be used to mark the reviewed classes by removing the proposed
modifier and adapting the comment. The comment should contain the date of the code review and the login names of the attendees.
All classes have initial code review rating red. The first code review lifts them to yellow, and the second one to green. The following tag marks classes that are ready for the first code review:
@kieler.rating proposed yellow <comment> |
After the code review has been performed, the same tag can be used to mark the reviewed classes by removing the proposed
modifier and adapting the comment. Similarly, the second code review can be marked using the green
modifier. The comment should contain the date of the code review, the login names of the attendees, and the ID of the code review in Crucible (such as KI-15
).
The design and code review tags are processed automatically using a custom doclet during Bamboo builds. The result is displayed in a generated HTML page:
http://rtsys.informatik.uni-kiel.de/~kieler/rating/