From 809efee3fe09f9ac13424e342581cd82d17b5175 Mon Sep 17 00:00:00 2001 From: ofir-frd Date: Sun, 18 May 2025 15:31:07 +0300 Subject: [PATCH] docs: add Repo Statistics tool documentation and update feature tables --- README.md | 3 +- docs/docs/index.md | 1 + docs/docs/recent_updates/index.md | 1 + docs/docs/tools/index.md | 3 +- docs/docs/tools/repo_statistics.md | 46 ++++++++++++++++++++++++++++++ docs/mkdocs.yml | 1 + 6 files changed, 53 insertions(+), 2 deletions(-) create mode 100644 docs/docs/tools/repo_statistics.md diff --git a/README.md b/README.md index 21c2309a..44ff7bf9 100644 --- a/README.md +++ b/README.md @@ -92,6 +92,7 @@ Supported commands per platform: | | [Test](https://qodo-merge-docs.qodo.ai/tools/test/) 💎 | ✅ | ✅ | | | | | [Implement](https://qodo-merge-docs.qodo.ai/tools/implement/) 💎 | ✅ | ✅ | ✅ | | | | [Scan Repo Discussions](https://qodo-merge-docs.qodo.ai/tools/scan_repo_discussions/) 💎 | ✅ | | | | +| | [Repo Statistics](https://qodo-merge-docs.qodo.ai/tools/repo_statistics/) 💎 | ✅ | | | | | | [Auto-Approve](https://qodo-merge-docs.qodo.ai/tools/improve/?h=auto#auto-approval) 💎 | ✅ | ✅ | ✅ | | | | | | | | | | USAGE | [CLI](https://qodo-merge-docs.qodo.ai/usage-guide/automations_and_usage/#local-repo-cli) | ✅ | ✅ | ✅ | ✅ | @@ -110,7 +111,7 @@ Supported commands per platform: | | [PR interactive actions](https://www.qodo.ai/images/pr_agent/pr-actions.mp4) 💎 | ✅ | ✅ | | | | | [Impact Evaluation](https://qodo-merge-docs.qodo.ai/core-abilities/impact_evaluation/) 💎 | ✅ | ✅ | | | | | [Code Validation 💎](https://qodo-merge-docs.qodo.ai/core-abilities/code_validation/) | ✅ | ✅ | ✅ | ✅ | -| | [Auto Best Practices 💎](https://qodo-merge-docs.qodo.ai/core-abilities/auto_best_practices/) | ✅ | | | | +| | [Auto Best Practices 💎](https://qodo-merge-docs.qodo.ai/core-abilities/auto_best_practices/) | ✅ | | | | - 💎 means this feature is available only in [Qodo Merge](https://www.qodo.ai/pricing/) [//]: # (- Support for additional git providers is described in [here](./docs/Full_environments.md)) diff --git a/docs/docs/index.md b/docs/docs/index.md index 8dd7c955..94e31084 100644 --- a/docs/docs/index.md +++ b/docs/docs/index.md @@ -48,6 +48,7 @@ PR-Agent and Qodo Merge offers extensive pull request functionalities across var | | [Test](https://qodo-merge-docs.qodo.ai/tools/test/) 💎 | ✅ | ✅ | | | | | [Implement](https://qodo-merge-docs.qodo.ai/tools/implement/) 💎 | ✅ | ✅ | ✅ | | | | [Scan Repo Discussions](https://qodo-merge-docs.qodo.ai/tools/scan_repo_discussions/) 💎 | ✅ | | | | +| | [Repo Statistics](https://qodo-merge-docs.qodo.ai/tools/repo_statistics/) 💎 | ✅ | | | | | | [Auto-Approve](https://qodo-merge-docs.qodo.ai/tools/improve/?h=auto#auto-approval) 💎 | ✅ | ✅ | ✅ | | | | | | | | | | USAGE | [CLI](https://qodo-merge-docs.qodo.ai/usage-guide/automations_and_usage/#local-repo-cli) | ✅ | ✅ | ✅ | ✅ | diff --git a/docs/docs/recent_updates/index.md b/docs/docs/recent_updates/index.md index 158fb5ca..eba49559 100644 --- a/docs/docs/recent_updates/index.md +++ b/docs/docs/recent_updates/index.md @@ -12,6 +12,7 @@ It also outlines our development roadmap for the upcoming three months. Please n - **Scan Repo Discussions Tool**: A new tool that analyzes past code discussions to generate a `best_practices.md` file, distilling key insights and recommendations. ([Learn more](https://qodo-merge-docs.qodo.ai/tools/scan_repo_discussions/)) - **Enhanced Models**: Qodo Merge now defaults to a combination of top models (Claude Sonnet 3.7 and Gemini 2.5 Pro) and incorporates dedicated code validation logic for improved results. ([Details 1](https://qodo-merge-docs.qodo.ai/usage-guide/qodo_merge_models/), [Details 2](https://qodo-merge-docs.qodo.ai/core-abilities/code_validation/)) - **Chrome Extension Update**: Qodo Merge Chrome extension now supports single-tenant users. ([Learn more](https://qodo-merge-docs.qodo.ai/chrome-extension/options/#configuration-options/)) + - **Repo Statistics Tool**: A new tool that provides repository statistics on time to merge and time to first comment. ([Learn more](https://qodo-merge-docs.qodo.ai/tools/repo_statistics/)) === "Future Roadmap" - **Smart Update**: Upon PR updates, Qodo Merge will offer tailored code suggestions, addressing both the entire PR and the specific incremental changes since the last feedback. diff --git a/docs/docs/tools/index.md b/docs/docs/tools/index.md index e422b856..817ed9c0 100644 --- a/docs/docs/tools/index.md +++ b/docs/docs/tools/index.md @@ -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. diff --git a/docs/docs/tools/repo_statistics.md b/docs/docs/tools/repo_statistics.md new file mode 100644 index 00000000..b34ef9b9 --- /dev/null +++ b/docs/docs/tools/repo_statistics.md @@ -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. diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 8525fdee..45f157fc 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -41,6 +41,7 @@ nav: - 💎 Similar Code: 'tools/similar_code.md' - 💎 Implement: 'tools/implement.md' - 💎 Scan Repo Discussions: 'tools/scan_repo_discussions.md' + - 💎 Repo Statistics: 'tools/repo_statistics.md' - Core Abilities: - 'core-abilities/index.md' - Auto best practices: 'core-abilities/auto_best_practices.md'