Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Reviews/Design
< Reviews
The Reviews project has three reference implementation that provide code and model review integration for Eclipse: Task-based Reviews (TBR), R4E and the Gerrit Connector. TBR and R4E specify their own review models that are shared through file systems or task repositories while the Gerrit connector uses a model provided by the Gerrit code review server.
Comparison of (planned) features
While each implementation uses a different mechanism for persisting review contents, sharing reviews and managing users requirements for the IDE integration largely overlap.
- Inline commenting: Review artifacts are presented through editors such as the Java editor, compare editor or graphical editors for modeling. Review comments (ananomalies) are visualized through markers and annotations or other means that make them visible inline with the content that is being reviewed.
- Notifications: As reviews are updated change notifications are displayed.
- Review management: Similar to tasks reviews have associated users, state, workflow etc. that is managed through a form based editor. While the specifics vary by implementation UI components such as user management are common.
- Offline support: To make reviews available offline reviews are persisted in an offline cache. Remote changes to the model need to be merged and potential conflicts resolved.