mirror of
https://github.com/qodo-ai/pr-agent.git
synced 2025-07-06 22:00:40 +08:00
Merge pull request #1908 from qodo-ai/of/doc-updates
docs: update README organization and add Qodo Merge open source link
This commit is contained in:
33
README.md
33
README.md
@ -31,12 +31,12 @@ PR-Agent aims to help efficiently review and handle pull requests, by providing
|
|||||||
|
|
||||||
- [Getting Started](#getting-started)
|
- [Getting Started](#getting-started)
|
||||||
- [News and Updates](#news-and-updates)
|
- [News and Updates](#news-and-updates)
|
||||||
- [Overview](#overview)
|
- [Why Use PR-Agent?](#why-use-pr-agent)
|
||||||
|
- [Features](#features)
|
||||||
- [See It in Action](#see-it-in-action)
|
- [See It in Action](#see-it-in-action)
|
||||||
- [Try It Now](#try-it-now)
|
- [Try It Now](#try-it-now)
|
||||||
- [Qodo Merge 💎](#qodo-merge-)
|
- [Qodo Merge 💎](#qodo-merge-)
|
||||||
- [How It Works](#how-it-works)
|
- [How It Works](#how-it-works)
|
||||||
- [Why Use PR-Agent?](#why-use-pr-agent)
|
|
||||||
- [Data Privacy](#data-privacy)
|
- [Data Privacy](#data-privacy)
|
||||||
- [Contributing](#contributing)
|
- [Contributing](#contributing)
|
||||||
- [Links](#links)
|
- [Links](#links)
|
||||||
@ -60,8 +60,9 @@ Run PR-Agent locally on your repository via command line: [Local CLI setup guide
|
|||||||
### Qodo Merge as post-commit in your local IDE
|
### Qodo Merge as post-commit in your local IDE
|
||||||
See [here](https://github.com/qodo-ai/agents/tree/main/agents/qodo-merge-post-commit)
|
See [here](https://github.com/qodo-ai/agents/tree/main/agents/qodo-merge-post-commit)
|
||||||
|
|
||||||
### Discover Qodo Merge 💎
|
### Discover Qodo Merge 💎
|
||||||
Zero-setup hosted solution with advanced features and priority support
|
Zero-setup hosted solution with advanced features and priority support
|
||||||
|
- **[FREE for Open Source](https://github.com/marketplace/qodo-merge-pro-for-open-source)**: Full features, zero cost for public repos
|
||||||
- [Intro and Installation guide](https://qodo-merge-docs.qodo.ai/installation/qodo_merge/)
|
- [Intro and Installation guide](https://qodo-merge-docs.qodo.ai/installation/qodo_merge/)
|
||||||
- [Plans & Pricing](https://www.qodo.ai/pricing/)
|
- [Plans & Pricing](https://www.qodo.ai/pricing/)
|
||||||
|
|
||||||
@ -101,11 +102,22 @@ New tool for Qodo Merge 💎 - `/scan_repo_discussions`.
|
|||||||
|
|
||||||
Read more about it [here](https://qodo-merge-docs.qodo.ai/tools/scan_repo_discussions/).
|
Read more about it [here](https://qodo-merge-docs.qodo.ai/tools/scan_repo_discussions/).
|
||||||
|
|
||||||
## Overview
|
## Why Use PR-Agent?
|
||||||
|
|
||||||
|
A reasonable question that can be asked is: `"Why use PR-Agent? What makes it stand out from existing tools?"`
|
||||||
|
|
||||||
|
Here are some advantages of PR-Agent:
|
||||||
|
|
||||||
|
- We emphasize **real-life practical usage**. Each tool (review, improve, ask, ...) has a single LLM call, no more. We feel that this is critical for realistic team usage - obtaining an answer quickly (~30 seconds) and affordably.
|
||||||
|
- Our [PR Compression strategy](https://qodo-merge-docs.qodo.ai/core-abilities/#pr-compression-strategy) is a core ability that enables to effectively tackle both short and long PRs.
|
||||||
|
- Our JSON prompting strategy enables us to have **modular, customizable tools**. For example, the '/review' tool categories can be controlled via the [configuration](pr_agent/settings/configuration.toml) file. Adding additional categories is easy and accessible.
|
||||||
|
- We support **multiple git providers** (GitHub, GitLab, BitBucket), **multiple ways** to use the tool (CLI, GitHub Action, GitHub App, Docker, ...), and **multiple models** (GPT, Claude, Deepseek, ...)
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
<div style="text-align:left;">
|
<div style="text-align:left;">
|
||||||
|
|
||||||
Supported commands per platform:
|
PR-Agent and Qodo Merge offer comprehensive pull request functionalities integrated with various git providers:
|
||||||
|
|
||||||
| | | GitHub | GitLab | Bitbucket | Azure DevOps | Gitea |
|
| | | GitHub | GitLab | Bitbucket | Azure DevOps | Gitea |
|
||||||
|---------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------|:------:|:------:|:---------:|:------------:|:-----:|
|
|---------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------|:------:|:------:|:---------:|:------------:|:-----:|
|
||||||
@ -227,17 +239,6 @@ The following diagram illustrates PR-Agent tools and their flow:
|
|||||||
|
|
||||||
Check out the [PR Compression strategy](https://qodo-merge-docs.qodo.ai/core-abilities/#pr-compression-strategy) page for more details on how we convert a code diff to a manageable LLM prompt
|
Check out the [PR Compression strategy](https://qodo-merge-docs.qodo.ai/core-abilities/#pr-compression-strategy) page for more details on how we convert a code diff to a manageable LLM prompt
|
||||||
|
|
||||||
## Why Use PR-Agent?
|
|
||||||
|
|
||||||
A reasonable question that can be asked is: `"Why use PR-Agent? What makes it stand out from existing tools?"`
|
|
||||||
|
|
||||||
Here are some advantages of PR-Agent:
|
|
||||||
|
|
||||||
- We emphasize **real-life practical usage**. Each tool (review, improve, ask, ...) has a single LLM call, no more. We feel that this is critical for realistic team usage - obtaining an answer quickly (~30 seconds) and affordably.
|
|
||||||
- Our [PR Compression strategy](https://qodo-merge-docs.qodo.ai/core-abilities/#pr-compression-strategy) is a core ability that enables to effectively tackle both short and long PRs.
|
|
||||||
- Our JSON prompting strategy enables us to have **modular, customizable tools**. For example, the '/review' tool categories can be controlled via the [configuration](pr_agent/settings/configuration.toml) file. Adding additional categories is easy and accessible.
|
|
||||||
- We support **multiple git providers** (GitHub, GitLab, BitBucket), **multiple ways** to use the tool (CLI, GitHub Action, GitHub App, Docker, ...), and **multiple models** (GPT, Claude, Deepseek, ...)
|
|
||||||
|
|
||||||
## Data Privacy
|
## Data Privacy
|
||||||
|
|
||||||
### Self-hosted PR-Agent
|
### Self-hosted PR-Agent
|
||||||
|
@ -24,7 +24,7 @@ To search the documentation site using natural language:
|
|||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
PR-Agent and Qodo Merge offers extensive pull request functionalities across various git providers:
|
PR-Agent and Qodo Merge offer comprehensive pull request functionalities integrated with various git providers:
|
||||||
|
|
||||||
| | | GitHub | GitLab | Bitbucket | Azure DevOps | Gitea |
|
| | | GitHub | GitLab | Bitbucket | Azure DevOps | Gitea |
|
||||||
| ----- |---------------------------------------------------------------------------------------------------------------------|:------:|:------:|:---------:|:------------:|:-----:|
|
| ----- |---------------------------------------------------------------------------------------------------------------------|:------:|:------:|:---------:|:------------:|:-----:|
|
||||||
|
Reference in New Issue
Block a user