Reviews Metric

Definition

The Reviews Metric is the total number of review cycles completed within a specified period.

A review cycle includes specific actions taken on a pull request (PR), which include:

1. Adding a Single Comment: Each time a user adds a comment to a PR, it is counts as one review cycle.
2. Submitting a Review: When a user submits a review—whether it involves approving, commenting, or requesting changes—it is counted as one review cycle.

Handling Multiple Review Cycles on the Same PR

If a user performs multiple review actions on the same PR, each action is counted as an individual review cycle. Examples include:

• Adding multiple single comments: Each comment is treated as a separate review cycle.
• Submitting multiple review actions (e.g., requesting changes and later adding comments): Each action is recorded as a distinct review cycle.

Why is This Metric Useful?

• Reflects collaboration and code quality assurance.
• Calculates reviews for individuals based on every review cycle for a Pull Request (PR).
• Provides a comprehensive view of the review activity.

How to Use it?

• Ensure every PR receives adequate review coverage.

Examples for Context

• Teams with consistent reviews maintain higher code quality.

Data Sources

• PR review events.

Calculation

• Total number of review events within the specified period.

Tunable Configurations

• Inclusion of specific types of reviews (e.g., comments vs. approvals).

Benchmarking Guidance

• Each PR should ideally receive at least one thorough review.

Error Margins and Limitations

• Reviews with minimal feedback may not indicate thorough evaluation.

Stakeholder Use Cases

• Team Leads: Balance reviewer workload.
• Developers: Monitor review contributions.