It's all about the answers!

Ask a question

Code Review - how do I comment on file changes and then approve the review?


Colin Duggan (15156) | asked Sep 17 '13, 11:10 a.m.
retagged Oct 06 '17, 4:03 p.m. by Ken Tessier (84117)

 Hi, 


I'm starting to use RTC for code review. I'm having trouble finding where the approval option is to be found. When i recieve a new "review" request i do the following;

  1. Open the "work items" view and run predefined query to find items waiting for my approval
  2. I open the item
  3. Navigate to the links tab 
  4. Find the changeset i'm interested in and open
  5. Review each of the change sets using the comparator built into my Eclipse RTC plugin
At this point i run into a problem. I can't find where i can 
a) mark a comment in one of the files i'm reviewing and 
b) approve the change so i can get it out of my work items view (and of course let the waiting developer continue work)

The story which opens which i click the work item does not have an "approvals" tab instead it only has overview, links and history. Not sure if this is significant.

Can someone tell me how i can go and approve the changes?

Thanks

Accepted answer


permanent link
David Lafreniere (4.7k7) | answered Oct 05 '17, 1:01 p.m.
FORUM MODERATOR / JAZZ DEVELOPER

As of RTC 6.0.1 you can use a built-in Code Review tool that lets you annotate/comment on specific lines of code during a review. (Note: You do not have to do step 3, 4 & 5 in your question). When you are done with the review, you then update the review approval on the "Approvals" tab of the work item (Note: if you are using a custom work item type, you will need to add this Approvals tab)

Here's more information on the Code Review tool:

In Rational Team Concert 6.0.1 we have introduced a new Code Review feature. Code review is integrated with RTC work items and Jazz SCM to provide developers with a seamless, low overhead work flow that is simple to use and is a natural extension to their daily activities. There isn’t a separate server installation, additional licensing fees or other costs associated with using RTC code review. Enabling code review for your projects is simple and takes only a few minutes to set up.

Reviewers can annotate specific lines of code, which helps developers quickly see and fix issues. Issues (or findings) can be marked as must-fix and the reviewer can accept or reject the changes. When preconditions are enabled, a code review cannot be approved if must-fix issues have not been resolved to everyone’s satisfaction.

Developers don’t have to worry about the intricacies of issue management because this is handled for them. Each issue has its own discussion thread and events are logged as the review progresses. Whenever an issue is updated, a new issue raised, or new code changes are added to the review, the events are logged so that you have a complete history of the review life-cycle. Because code reviews are iterative and can include code changes during the review cycle, any annotations on lines of code (issue markers) are automatically re-positioned and visual cues are provided to the reviewer so that they can easily see what has changed since they last looked at the code or since they last reviewed issues.

Team collaboration is accelerated through real-time notification of pending reviews, issues, and fixes. This is becoming more and more important as the number of globally distributed development teams increase. In fact, with the RTC SCM development team spread across three different time zones, it is common for them to have code changes that were written in one time zone reviewed by team members in another time zone.

Code review enables auditing for compliance. Issue status at delivery, approval information, the event logs, and other information captured during the review can be used for a variety of metrics and reporting requirements.

Since the introduction of code review in 6.0.1 more features have been added. Reviewers can inspect intermediate before and after file states, which is useful in advanced SCM workflows encountered when multiple developers are working on a common code base. We have added the ability to filter issues on the navigator pane on the left, add tags to issues, and various usability enhancements have been added.

The ability to extract work items is useful when an issue needs to be addressed but shouldn’t prevent delivery of the current code changes. The extracted work item captures the required work and will have its own code review cycle.

A SCM CLI command is also available to export code review data such as issues raised, issue activity, reviewer information, code delivery status, and other metrics in JSON or XML format. This enables customers to use their existing reporting tools or custom scripts for auditability and other reporting requirements

Additional Information:
Article: Rational Team Concert Code Review
Video: Introduction to Code Review (Part 1)
Video: Configuring Code Review (Part 2)
Video: Performing a Code Review (Part 3)
Knowledge Center: Working With the Code Review Tool

Michael Valenta selected this answer as the correct answer

One other answer



permanent link
Lauren Hayward Schaefer (3.3k11427) | answered Sep 18 '13, 7:05 a.m.
JAZZ DEVELOPER
edited Sep 18 '13, 7:06 a.m.
Hi Colin,

It's not currently possible to make comments in the code you're reviewing.  We typically post whatever comments we have in the associated work item.

You should be seeing an Approvals tab.  Have you tried opening the work item in both the Eclipse client and the web client?  You could check with an administrator to see if they've hidden the Approvals tab under certain conditions.

Your answer


Register or to post your answer.