Code Review Dashboard: Difference between revisions
Lars.kurth (talk | contribs) (Created page with "The Xen project has developed a code review Dashboard in collaboration with [http://bitergia.com/ Bitergia]. There are two variants of this dashboard * [https://kibana.bitergi...") |
Lars.kurth (talk | contribs) (→Panels) |
||
| Line 10: | Line 10: | ||
= Panels = |
= Panels = |
||
The Xen Project Code Review dashboard has 4 panels: One for documentation, a Community Panel, a Performance Panel and a Backlog Panel. |
|||
== Community Panel == |
|||
In this panel, several widgets are grouped by use-case. |
|||
=== Use case: Identify top reviewers (for both individuals and companies) === |
|||
==== <code>Evolution 'Reviewed-by' flag (no patchseries, no patches)</code> ==== |
|||
Shows the evolution of the <code>Reviewed-by</code> flag over time. Allows to create a time filter. |
|||
==== <code>Top People</code> and <code>Domain</code> <code>Reviewing Patches</code> ==== |
|||
Counts the number of people and organisations who commented on other people’s patches (by counting the <code>Reviewed-by</code> attributes) in the selected time period. Allows to filter by developer (e-mail address and e-mail domain). |
|||
=== Use case: Identify Imbalances between reviewers and contributors === |
|||
==== <code>Evolution Patches (no patchseries, no comments)</code> ==== |
|||
Shows the evolution of the patches posted over time. Allows to create a time filter. |
|||
==== <code>Top People</code> and <code>Domain Imbalance Analysis</code> ==== |
|||
Over the selected time period, the following fields are aggregated per person or domain * '''Balance''': Difference between patches posted and and comment activity. A positive number implies that the person or organisation comments more than she posts patches. * '''Patches''': Number of patches posted * '''Reviews''': Number of <code>Reviewed By</code> flags |
|||
=== Use case: Identify post-ack comments on patches === |
|||
==== <code>Evolution Comments Activity (no patchseries, no patches)</code> ==== |
|||
Shows the evolution of comments made on patches (both real and self-comments) over time. Allows to create a time filter. |
|||
==== <code>Top People</code> and <code>Domain Commenting on Patches</code> ==== |
|||
Over the selected time period, the following fields are aggregated per person or domain * '''Comments''': The number of review comments on other people’s patches. * '''Post ACK comments''': The number of comments made after a patch has been ACK’ed |
|||
=== Use case: Drill into Review activity information === |
|||
The following widgets are of particular interest to code submitters, reviewers and maintainers. A similar view, which is optimised to identifying which code reviews are almost complete are visible in the <code>Backlog</code> and <code>Data-Explorer</code> panels. |
|||
==== <code>Evolution Email Activity (patchseries, patches, comments)</code> ==== |
|||
Shows the evolution of review related e-mail activity over time. Allows to create a time filter. |
|||
==== <code>Evolution Patch Series (no patches, no comments)</code> ==== |
|||
Shows the evolution of patch series posted over time. Allows to create a time filter. |
|||
==== <code>Patch Series</code> ==== |
|||
Lists the patch series in an exportable table that satisfy selected filters. |
|||
==== <code>Reviews (using Reviewed-by flag)</code> ==== |
|||
Lists emails that set the <code>Reviewed-by</code> flag that satisfy selected filters. |
|||
==== <code>Comments</code> ==== |
|||
Lists emails comments that satisfy selected filters. |
|||
= Basic Operations = |
= Basic Operations = |
||
Revision as of 12:02, 15 April 2016
The Xen project has developed a code review Dashboard in collaboration with Bitergia. There are two variants of this dashboard
- kibana.bitergia.com/xen/app/kibana: User version
- kibana.bitergia.com/xen-edit/app/kibana: Administrator version (allows to create extra customizations]
This document provides a version of the documentation for the*user version* of the dashboard, that is editable and easily consumable
Basic Concepts
Panels
The Xen Project Code Review dashboard has 4 panels: One for documentation, a Community Panel, a Performance Panel and a Backlog Panel.
Community Panel
In this panel, several widgets are grouped by use-case.
Use case: Identify top reviewers (for both individuals and companies)
Evolution 'Reviewed-by' flag (no patchseries, no patches)
Shows the evolution of the Reviewed-by flag over time. Allows to create a time filter.
Top People and Domain Reviewing Patches
Counts the number of people and organisations who commented on other people’s patches (by counting the Reviewed-by attributes) in the selected time period. Allows to filter by developer (e-mail address and e-mail domain).
Use case: Identify Imbalances between reviewers and contributors
Evolution Patches (no patchseries, no comments)
Shows the evolution of the patches posted over time. Allows to create a time filter.
Top People and Domain Imbalance Analysis
Over the selected time period, the following fields are aggregated per person or domain * Balance: Difference between patches posted and and comment activity. A positive number implies that the person or organisation comments more than she posts patches. * Patches: Number of patches posted * Reviews: Number of Reviewed By flags
Use case: Identify post-ack comments on patches
Evolution Comments Activity (no patchseries, no patches)
Shows the evolution of comments made on patches (both real and self-comments) over time. Allows to create a time filter.
Top People and Domain Commenting on Patches
Over the selected time period, the following fields are aggregated per person or domain * Comments: The number of review comments on other people’s patches. * Post ACK comments: The number of comments made after a patch has been ACK’ed
Use case: Drill into Review activity information
The following widgets are of particular interest to code submitters, reviewers and maintainers. A similar view, which is optimised to identifying which code reviews are almost complete are visible in the Backlog and Data-Explorer panels.
Evolution Email Activity (patchseries, patches, comments)
Shows the evolution of review related e-mail activity over time. Allows to create a time filter.
Evolution Patch Series (no patches, no comments)
Shows the evolution of patch series posted over time. Allows to create a time filter.
Patch Series
Lists the patch series in an exportable table that satisfy selected filters.
Reviews (using Reviewed-by flag)
Lists emails that set the Reviewed-by flag that satisfy selected filters.
Comments
Lists emails comments that satisfy selected filters.
