How Collaborator’s Eclipse Plug-In Makes Your Life Easier
Ask any Eclipse developer and they will tell you that they prefer to do all of their work in Eclipse, rather than toggling between multiple systems. This is especially true for code reviews. So it makes perfect sense that we created an Eclipse plug-in for Collaborator, which gives you the ability to bring the whole review experience inside your Eclipse environment.
Think about how much time and aggravation you could save by collaborating with co-workers in Eclipse. For example, imagine seeing something in the review that raises questions about another part of the code that isn’t in review, now with one click you can quickly pull up that other code and resolve the issue.
Ready to get started?
Installing the Eclipse Plug-in is easy. Once you download it, simply tell the plug-in where your Collaborator server is by giving it your URL, username and password - and you’re ready to go. The Eclipse Plug-in serves two main purposes:
1.Upload Code to the Server for Review
First, it allows you to upload code to the server to be reviewed. There are a variety of ways to do this depending on the version control system you are using. For most systems you right-click on the project, choose team and then click “add to review”.
Now a window will pop up that allows you to specify if this is a new review or if you want to add your file to an existing review. Next you see a list of changed or new files that you can select from. At this point, you can also add other documents to the review such as a Word doc or PDF. This is especially useful if you want to include the requirements description or technical specification with the code you’re putting into review.
After the system uploads the file for review, it then asks the version control system if there was a previous version of the file and creates a diff so reviewers can just look at the changes, rather than the entire file.
2. Use Eclipse to Perform the Code Review
Second, as we mentioned earlier, you can perform the actual review in Eclipse. The idea here is that if you are an Eclipse user, you should be able to stay within your IDE and still perform code reviews.
For example, provided that you have a plug-in from your vendor that allows highlighting, the Collaborator Eclipse plug-in allows you to hook into that code and see impact highlighting in your review, regardless of the development language you are using.
As an added bonus, if the plug-in is able to find the files that are being reviewed in your current workspace, it will identify them with green check-marks to indicate they are currently under review. If previous reviewers have identified and noted defects in the code, Collaborator will identify this with bug icons to indicate the presence of a defect. The plug-in also makes any flagged defects easy to find by displaying an icon in the native code editor. These icons are color coded to indicate the state of the defect:
- Red indicates defects that have been logged.
- Blue indicates defects that have been identified and moved to an external issue tracker.
- Green indicated the defect has been “marked fixed” by a reviewer.
If you hover over the icon, it also shows the text that the reviewer added when the defect was created.
Whenever your action items refresh, Collaborator also refreshes these indicators.
We recognize that your time is valuable and that being able to work within your IDE whenever possible is important. Want to learn more? Click here to try it for yourself.