Create performance metrics for Cauldron
Feature Motivation
The performance of the development of a project is a set of important metrics when analyzing the health status of a software project. It would be nice if Cauldron could have this kind of metrics and visualizations.
Possible Implementations
We will have two different sections: issues and reviews. Both will have similar metrics and visualizations:
- Metrics: We will have two different blocks, each one with different metrics:
- The first block will show the following metrics:
- For the period corresponding to the last 30 days with respect to the current date, the median closing time (
time_to_close_days
) of the closed items during the corresponding period. - For the period corresponding to the last year with respect to the current date, the median closing time (
time_to_close_days
) of the closed items during the corresponding period. - Comparison (in percentage) of the median closing time (
time_to_close_days
) of the closed items during the last year and the previous one.
- For the period corresponding to the last 30 days with respect to the current date, the median closing time (
- The second block will show the following static metrics (this means they are calculated for all available time):
- Average time that open items have been in that state.
- Median time that open items have been in that state.
- Total open items.
- The first block will show the following metrics:
- Visualizations: We will have 4 different visualizations, divided into a 2x2 grid:
- (Top left) Average closing time (
time_to_close_days
) of items created in the period selected by the user, together with the median: To generate this visualization, we first group the items by creation date (created_at
), select those corresponding to the period chosen by the user, and calculate the average and median closing time (time_to_close_days
) of the total of the selected items. We will represent the average with a bar graph and the median with a line graph. - (Top right) Items still open by creation date: This visualization corresponds to one already created in the specific sections of Activity. In the case of issues, it corresponds to the graph called
# Open issues age
(change its name). - (Bottom left) Average closing time (
time_to_close_days
) of items closed in the period selected by the user, together with the median: To generate this visualization, we first group the items by closing date (closed_at
), select those corresponding to the period chosen by the user, and calculate the average and median closing time (time_to_close_days
) of the total of the selected items. We will represent the average with a bar graph and the median with a line graph. - (Bottom right) Ratio between created and closed items in the period of time selected by the user: To generate this visualization, we first generate two time series grouping the items by their creation date (
created_at
) and their closing date (closed_at
). Then we generate a third time series that will be the quotient between the first (those grouped by creation date) and the second (those grouped by closing date). This third time series will be the one represented in the visualization, with a line graph.
- (Top left) Average closing time (
Edited by Sergio Merino Hernández