Details
-
Suggestion
-
Resolution: Unresolved
-
None
-
1
-
Description
from CRUC-543:
have a checklist associated with the review. Each item on the checklist has a pass/fail, a comment, and possibly an associated Jira issue.
the type of checks would be e.g.
Code is commented correctly
Code complies with Architecture Document
Method Names are clear and correctly cased
etc etc
Ideally these fields on the checklists would be defined by project, and copyable from other projects.
This requirement comes from Quality (eg ISO 9000) type requirements where the QMS specifies a checklist for code reviews, and we need to measure the results.
------------
summarize review checklist
At the Review Summary stage, the Developer must ensure:
- All comments in the review have been responded to adequately
2. Unit test results have been sighted by a reviewer
3. Code coverage results have been sighted by a reviewer
4. If User-facing changes, the running UI has been inspected by a reviewer
5. JIRAs have been raised for all non-trivial rework required
Alternative solution #1:
In 'Administration' > 'Project settings' > project > 'Default review objectives' you can prepare a wiki markup template for review objectives. You can use this template as a checklist. You can use icons like or to mark which tasks have been completed.
Alternative solution #2:
With 'Linking reviews to multiple Jira issues' feature delivered in Crucible 4.6 you can create and link more any number of Jira issues with a single code review. This way you can use Jira to track such if the checklist have been completed.
Alternative solution #3:
It is also possible create Jira issues from comments. They are being displayed on the review summary page. Thus it's possible to create comments and create linked issues for them.
Alternative solution #4:
In Crucible 4.3 the 'Resolvable comments' feature has been delivered. You can create a set of global comments and mark all of them as 'needs resolution'. Review workflow will warn if there are any unresolved comments before closing a review.