Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • The author goes through all comments in Crucible and leaves a note about his decision
  • The author may schedule a followup meeting which is only held online to review for example auxiliary classes
  • The author adds a tag to the reviewed classes to mark them as reviewed according to the proposed rating (see below)

Code Tags

When classes are ready for a design review, they should be marked with the following tag:

Code Block
languagenone
@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.

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:

Code Block
languagenone
@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 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/