Browse Prior Art Database

The system to optimize code review with good visual and structured view

IP.com Disclosure Number: IPCOM000220112D
Publication Date: 2012-Jul-23
Document File: 6 page(s) / 86K

Publishing Venue

The IP.com Prior Art Database

Abstract

Disclosed is a system which is based on existed data structure of change set and other related materials. It will provide different types of hierarchies to show internal relations for these materials. First, all materials will be organized with their inner relationship based on code structure-call hierarchy, implementation hierarchy, impact of the changes or code/document resources and so on. Besides, comments will be added into every change set to show what it is intended for, which will help the reviewer to get better understand of the change in a methodical view. And also, the method can split a change into fine-grained sub-changes based on certain features, then provide a top-down view or other tree view to show an organized structure of whole code changes. It will help the reviewer to pick up the focal part of the changes. At last,this system will provide a view to compare a file within more than two versions based on snapshot, easy to track all the modify history of the file.

This text was extracted from a PDF file.
This is the abbreviated version, containing approximately 52% of the total text.

Page 01 of 6

The system to optimize code review with good visual and structured view

Code review is the systematic examination of source code. It is intended to find and fix mistakes overlooked in the initial development phase, improving both the overall quality of software and the developers' skills. Reviews are done in various forms such as pair programming, informal walk-through, and formal inspections.

Inconvenience occurred from time to time is that the reviewer is hard to find the entrance which couldshow him where to start with his review or logic relations among all change sets, since a lot of change sets have been made by the developer and committed to the reviewer for review with no structure information. Ideally, reviewer could receive an organized and better described change sets as well as an entrance file identified already, then the reviewer could start his review journey with high efficiency.

Disclosed is a system based on existed data structure of change set and other related materials. It will provide different types of hierarchies to show internal relations for these materials.

First, all materials will be organized with their inner relationship based on code structure-call hierarchy, implementation hierarchy, impact of the changes or code/document resources and so on.

Besides, comments will be added into every change set to show what it is intended for. All these comments are bound with change

set instead of lines of codes so that information will not get lost when codes changed in following version. The comments will help reviewer get better understand of the change in a methodical view.

And also, the method can split a change into fine-grained sub-changes based on certain features, then provide a top-down view or other tree view to show an organized structure of whole code changes. It will help the reviewer to pick up the focal part of the changes.

At lastthis system will provide a view to compare a file within more than two versions based on snapshot, easy to track all the modify history of the file.

To sum up, because it will clearly show the relations between change sets and why the change is made, the method will help the reviewer establish a comprehensive understanding efficiently, especially when the code change is pretty huge.

This system include 2 parts, one is for submitter to prepare the review package for review, the other is for reviewer to review the package, provide comments and track result.


1.Generate the review package


The system provide template to use in organizing the code review materials. User need to follow the template to generate thecode review package for reviewer.

1


Page 02 of 6

The system can help user to add the related materials into the package, such as the work it...