xiaxinhang/pr-agent
1
0
Fork 0
mirror of https://github.com/qodo-ai/pr-agent.git synced 2025-07-09 07:10:37 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: add Repo Statistics tool documentation and update feature tables

Browse Source
This commit is contained in:
ofir-frd
2025-05-18 15:31:07 +03:00
parent 65d9269bf2
commit 809efee3fe
6 changed files with 53 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
docs/docs/tools/index.md
View File

@ -3,7 +3,7 @@
Here is a list of Qodo Merge tools, each with a dedicated page that explains how to use it:
| Tool | Description |
| ---------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
|------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------|
| **[PR Description (`/describe`](./describe.md))** | Automatically generating PR description - title, type, summary, code walkthrough and labels |
| **[PR Review (`/review`](./review.md))** | Adjustable feedback about the PR, possible issues, security concerns, review effort and more |
| **[Code Suggestions (`/improve`](./improve.md))** | Code suggestions for improving the PR |
@ -20,5 +20,6 @@ Here is a list of Qodo Merge tools, each with a dedicated page that explains how
| **💎 [CI Feedback (`/checks ci_job`](./ci_feedback.md))** | Automatically generates feedback and analysis for a failed CI job |
| **💎 [Implement (`/implement`](./implement.md))** | Generates implementation code from review suggestions |
| **💎 [Scan Repo Discussions (`/scan_repo_discussions`](./scan_repo_discussions.md))** | Generates `best_practices.md` file based on previous discussions in the repository |
| **💎 [Repo Statistics (`/repo_statistics`](./repo_statistics.md))** | Provides repository statistics on time to merge and time to first comment |
Note that the tools marked with 💎 are available only for Qodo Merge users.

46
docs/docs/tools/repo_statistics.md Normal file
View File

@ -0,0 +1,46 @@
`Platforms supported: GitHub`
## Overview
The `repo_statistics` tool analyzes statistics from merged pull requests over the past 12 months prior to Qodo Merge installation.
It calculates key metrics that help teams establish a baseline of their PR workflow efficiency.
!!! note "Active repositories are needed"
The tool is designed to work with real-life repositories, as it relies on actual discussions to generate meaningful insights.
At least 30 merged PRs are required to generate meaningful statistical data.
### Metrics Analyzed
- **Median time to merge:** The median time it takes for PRs to be merged after opening
- **Average time to merge:** The average time it takes for PRs to be merged after opening
- **Median time to first comment:** The median time it takes to get the first comment on a PR
- **Average time to first comment:** The average time it takes to get the first comment on a PR
### Usage
The tool can be invoked manually by commenting on any PR:
```
/repo_statistics
```
In response, the bot will comment with the statistical data.
Note that the scan can take several minutes to complete, since up to 100 PRs are scanned.
!!! info "Automatic trigger"
Upon adding the Qodo Merge bot to a repository, the tool will automatically scan the last 365 days of PRs and send them to MixPanel, if enabled.
## Example usage
![repo statistics comment](https://codium.ai/images/pr_agent/repo_statistics_comment.png){width=640}
MixPanel optional presentation:
![repo statistics mixpanel](https://codium.ai/images/pr_agent/repo_statistics_mixpanel.png){width=640}
### Configuration options
- Use `/repo_statistics --repo_statistics.days_back=X` to specify the number of days back to scan for discussions. The default is 365 days.
- Use `/repo_statistics --repo_statistics.minimal_number_of_prs=X` to specify the minimum number of merged PRs needed to generate the statistics. The default is 30 PRs.