Skip to main content

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.

Jump to: navigation, search

Difference between revisions of "Mylyn/UCOSP 2015 Project/documentation"

(Created page with " == Gerrit Workflow Modes == A new mode has been introduced to the Gerrit connector that introduces the concept of '''artifacts'''. This mode of setting artifacts is complete...")
 
 
Line 1: Line 1:
  
== Gerrit Workflow Modes ==
+
== Gerrit Usage Modes ==
  
A new mode has been introduced to the Gerrit connector that introduces the concept of '''artifacts'''. This mode of setting artifacts is completely optional and the default behavior remains the same as the old one. When you first open Eclipse, you will be prompted to change the settings of your repositories (confirm old behavior or try out the new behavior). You can also find the new settings on the repository settings page as pictured below:
+
The Gerrit connector supports two usage modes:
  
[[File:New_Gerrit_workflows.png]]
+
* '''Using Gerrit With an Issue Tracker''': To reduce task list clutter and duplication, reviews with a task URL in the description are listed on their associated task instead of in the task list, and the task is decorated with the glasses icon when it has incoming reviews.  
  
===  Summarizing the new modes ===
+
* '''Using Gerrit By Itself''': All reviews are treated as tasks: they are shown in the task list and can be activated and scheduled.
  
There are two primary new modes, as described before:
+
===  Using Gerrit with an Issue Tracker ===
  
* '''With a task tracker''': Reduce task list clutter: do not treat reviews as tasks if they refer to a task in the task list. These reviews are listed on their associated task instead of in the task list, and the task is decorated with the glasses icon when it has incoming reviews. This gives us the concept of "artifacts". These reviews that are listed and linked instead of on the task list are our "artifacts".  
+
When using Gerrit with an issue tracker such as Bugzilla, it is more natural to treat reviews as artifacts produced while working on a task, rather than as separate tasks with their own context, scheduled date, and due date. When the Issue Tracker usage mode is selected, reviews whose commit message contains the URL of another task in the task list are considered ''review artifacts''.
  
* '''Alone''': All reviews are treated as tasks: they are shown in the task list and can be activated and scheduled.  
+
When this mode is selected, review artifacts will be shown in the task editor of the associated task instead of the task list. This way you can easily see all the reviews for the task including their incoming state. Filtering review artifacts from the task list significantly reduces clutter and incoming review noise. Review artifacts cannot be scheduled or activated; instead, schedule or activate the associated task.
  
===  New features for artifacts ===
+
[[File:task_editor_reviews_section.png]]
  
For a review to be eligible to be converted to an artifact, it must first fit some criteria:
+
Note that you will still be able search for review artifacts using the text filter in the task list.
  
* The review must have an associated task with it
+
===== Incoming Reviews =====
* The review must not already have a '''context, scheduled date, or due date'''
+
  
Then, when reviews are synchronized they will be marked as artifacts automatically.
+
When a task has incoming reviews, the glasses icon will be shown next to the task in the task list:
  
When opting to use task tracker mode and artifacts, we gain a few benefits. They are summarized below.  
+
[[File:Review_incoming.png]]
  
===== Reviews that are artifacts are hidden =====
+
Open the task to see which reviews have incoming changes.
  
It can be more natural to look at reviews as directly linked to a task and not have them listed twice in this sense. By default, a task that is an artifact will not be shown in your task list. You can still search for them in your filter list and have them appear but generally they will stay out of your way.
+
=== Selecting a Usage Mode ===
  
Additionally, things that are specific to a task are now hidden. For example, scheduling and context support is then hidden as it better suited for the associated task. This can be done on the task itself, rather than the review if you still want to schedule something.
+
The usage mode can be configured on the repository settings page as shown here:
+
===== Tasks now have links to reviews =====
+
  
Instead of looking up a task and then looking up the review for it in your "reviews", you can now jump directly to the review from the task itself. This is how clutter is reduced -- this will be your primary new workflow for dealing with completing reviews.
+
[[File:New_Gerrit_workflows.png]]
  
[[File:Reviews_section.png]]
+
When enabling the Issue Tracker mode, existing reviews in your task list will be converted to review artifacts the next time they are synchronized. Only reviews whose commit message contains the URL of a task in the task list will be converted; additionally, reviews with a context, scheduled date, or due date will not be converted. You can switch back to the "By Itself" mode at any time; this will cause all review artifacts to become tasks again.
 
+
===== Incoming reviews decorator =====
+
 
+
You will be able to tell something has changed now by the glasses indicator. To reduce clutter, this will be your main indicator to know when something has changed and you should look for it.
+
 
+
[[File:Review_incoming.png]]
+

Latest revision as of 02:18, 9 March 2016

Gerrit Usage Modes

The Gerrit connector supports two usage modes:

  • Using Gerrit With an Issue Tracker: To reduce task list clutter and duplication, reviews with a task URL in the description are listed on their associated task instead of in the task list, and the task is decorated with the glasses icon when it has incoming reviews.
  • Using Gerrit By Itself: All reviews are treated as tasks: they are shown in the task list and can be activated and scheduled.

Using Gerrit with an Issue Tracker

When using Gerrit with an issue tracker such as Bugzilla, it is more natural to treat reviews as artifacts produced while working on a task, rather than as separate tasks with their own context, scheduled date, and due date. When the Issue Tracker usage mode is selected, reviews whose commit message contains the URL of another task in the task list are considered review artifacts.

When this mode is selected, review artifacts will be shown in the task editor of the associated task instead of the task list. This way you can easily see all the reviews for the task including their incoming state. Filtering review artifacts from the task list significantly reduces clutter and incoming review noise. Review artifacts cannot be scheduled or activated; instead, schedule or activate the associated task.

Task editor reviews section.png

Note that you will still be able search for review artifacts using the text filter in the task list.

Incoming Reviews

When a task has incoming reviews, the glasses icon will be shown next to the task in the task list:

Review incoming.png

Open the task to see which reviews have incoming changes.

Selecting a Usage Mode

The usage mode can be configured on the repository settings page as shown here:

New Gerrit workflows.png

When enabling the Issue Tracker mode, existing reviews in your task list will be converted to review artifacts the next time they are synchronized. Only reviews whose commit message contains the URL of a task in the task list will be converted; additionally, reviews with a context, scheduled date, or due date will not be converted. You can switch back to the "By Itself" mode at any time; this will cause all review artifacts to become tasks again.

Back to the top