PR Summary (Code)

Target Audience

This report is designed for Engineering leads who need to assess the overall status of a PR executed by a team member. The insights provided in this report can be leveraged effectively to assess the progress of code & quality of code in the pull request/merge request.

Report Overview

The PR summary report serves to:

1. Highlight Flags: Display flags associated directly with the PR.

2. Indicate Age of PR: Indicates the age of the PR since it's inception, the age of the PR can help the user draw valuable insights into efficiency as well as bottlenecks associated with the PR.

3. Showcase associated Issues: All the issues that are associated with the PR in the project management tool.

4. Showcase PR details: Important details about the PR e.g. number of reviewers, contributors, branch details, etc.

5. Indicate Released Status: Indicate the status of release in production or the underlying PR reaching the configured production branch (in the configurations associated with the code version control system).

PR Health Analysis

The report computes the health of a PR using the flags associated with the PR (based on the code introduced in various files in source branch associated with the PR).

Note: Rules for computing the health can be customized using the report configurator.

Optional Deep Dives

Users can explore a variety of data points across the following categories:

1. Core PR Data: Metrics shown in the Overview section, extracted from the code repository tool (e.g. Github). These provide insights into execution of the PR, quality of code and potential impediments for closure.

2. Code Review Data: Metrics in the Code review section (available when at least one review is conducted by the reviewers) indicates the quality of code review and the quality of closure of review comments.

3. Deployment Data: Metrics in the Deployment Overview section (available when a CI/CD tool is integrated) offer insights on:

   • Deployment frequency.
   • Average deployments across environments.
   • The intent to not just build but also deploy the the functionality to end-users.

4. Issue Data: Metrics in the Issue Overview section hightlights critical data points related to all the issues associated with the PR.

Data sources

The report integrates data from:

1. Project Management Tools: e.g., Jira.
2. Version Control Systems: e.g., GitHub.
3. CI/CD Tools: e.g., Jenkins.

Recommendation: Connect your project management tool and version control system to unlock the full potential of this report.