Introduction
The role and significance of code review have been agreed by many technical teams, but it is often not executed effectively, or even considered a time-consuming and laborious task. With some tools, code review can be performed more easily and efficiently. The Jupiter described in this article is one of them.
Jupiter Overview
Jupiter is an open-source Eclipse plug-in that stores review data in XML format and shares the review results within the team through SVN/CVS. A simple task is to establish the correspondence between the review problem and the specific source code. (You can click the problem in the review problem list to jump to the corresponding code segment, click the review question mark on the code segment to correspond to the specific problem description.) The review question List supports various filter rules (based on the review question status, owner, etc, this filter can be used to list issues that need attention in the specific stage ).
This plug-in is added in eclipse3.7 _ 201110707.
Jupiter code review process
The Code review process of Jupiter is as follows:
- 1. Create a review task: the code modifier or TL creates a review task, specifying the code file to be reviewed, the person participating in the review, and defining the problem type and severity level.
- 2. Individual review stage: Start the individual's independent review and add potential problems to the problem list.
- 3. Team review stage: The team members sit together to discuss issues in the personal review stage, determine whether to fix and assign the solution personnel.
- 4. Problem repair phase: each person fixes the problem assigned to himself, and changes the problem status after the problem is fixed.
1. Create a review task
Configuration by the reviewer (Code author, Team Leader, or PM.
Go to the Project Properties> review option page. Click "new..." to set the corresponding reviewid and description
Select the file for review. You can select multiple files at a time.
Add a person to participate in code review
Select the reviewer
The next few steps are to set the problem type, severity level, and filter. Modify or use the default value according to the actual situation. After finishing, the. Jupiter file is generated in the project root directory and submitted to SVN.
After the configuration is complete, the Jupiter will generate the ". Jupiter" file under the project root directory and save the file to CVS. Now, the reviewer can notify you of the Code review. You can send notifications by email. The notification content should include the following:
- Project name, review ID, and list of participating reviewers.
- Description of the Code to be reviewed, such as functions and requirements
- Add and delete files
- Affected but not inConfigurationComponents specified in
After the notification is completed, the members can officially perform code reviews.
2. Personal review stage
Update the latest source code and. Jupiter files from SVN. In eclipse, choose Window)> Open perspective)> Review. Then selectIndividual Phase:
Select a file to start review. When a problem is found, the cursor stops at the problematic code and right-click and select "add review issue ......"
In "Review editor", select the problem type and severity, add a summary and a detailed description, and save the configuration. We can see that the Code with the review problem added will be marked at the beginning of the line.
After completing the personal review, upload the data in the Jupiter review data directory to SVN.
3. Team review stage
The team members are sitting together, updating the latest review data from SVN, selecting "Team phase" from the review attempt, and clicking the problem in "review table" will jump to the corresponding code, we will discuss whether the Code has problems. In "Review editor", allocate the repair personnel and solutions and save them.
After the review is completed, the team uploads the review data to SVN.
4. Problem repair phase
When a person returns to his or her work machine, updates the latest review data, and selects "rework phase" from the review attempt, the problems assigned to him will be listed in "review table" and fixed one by one, in "Review editor", change the problem status to "resovled", save and upload the review data to SVN.
After rework is completed, the reviewers will check again. If the check fails, you can change the problem status to "re-opened". After the problem is fixed, change the status to "closed ",
So far, a code review process has ended.