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

docs: improve /implement tool documentation and update news section

Browse Source
This commit is contained in:
mrT23
2025-01-02 16:49:59 +02:00
parent f6b80174b5
commit b570c758aa
3 changed files with 25 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -41,6 +41,17 @@ Qode Merge PR-Agent aims to help efficiently review and handle pull requests, by
## News and Updates ## News and Updates
### Jan 2, 2025
New tool: [/Implement 💎](https://qodo-merge-docs.qodo.ai/tools/implement/), which converts human code review discussions and feedback into ready-to-commit code changes.
<kbd><img src="https://codium.ai/images/pr_agent/implement1.png" width="512"></kbd>
### Jan 1, 2025
Update logic and [documentation](https://qodo-merge-docs.qodo.ai/usage-guide/changing_a_model/#ollama) for running local models via Ollama.
### December 30, 2024 ### December 30, 2024
Following [feedback](https://research.kudelskisecurity.com/2024/08/29/careful-where-you-code-multiple-vulnerabilities-in-ai-powered-pr-agent/) from the community, we have addressed two vulnerabilities identified in the open-source PR-Agent project. The fixes are now included in the newly released version (v0.26), available as of today. Following [feedback](https://research.kudelskisecurity.com/2024/08/29/careful-where-you-code-multiple-vulnerabilities-in-ai-powered-pr-agent/) from the community, we have addressed two vulnerabilities identified in the open-source PR-Agent project. The fixes are now included in the newly released version (v0.26), available as of today.
@ -79,12 +90,6 @@ Focused mode
<kbd><img src="https://qodo.ai/images/pr_agent/code_suggestions_focused_mode.png" width="512"></kbd> <kbd><img src="https://qodo.ai/images/pr_agent/code_suggestions_focused_mode.png" width="512"></kbd>
### November 4, 2024
Qodo Merge PR Agent will now leverage context from Jira or GitHub tickets to enhance the PR Feedback. Read more about this feature
[here](https://qodo-merge-docs.qodo.ai/core-abilities/fetching_ticket_context/)
## Overview ## Overview
<div style="text-align:left;"> <div style="text-align:left;">
@ -158,7 +163,7 @@ ___
\ \
‣ **Similar Code 💎 ([`/find_similar_component`](https://pr-agent-docs.codium.ai/tools/similar_code/))**: Retrieves the most similar code components from inside the organization's codebase, or from open-source code. ‣ **Similar Code 💎 ([`/find_similar_component`](https://pr-agent-docs.codium.ai/tools/similar_code/))**: Retrieves the most similar code components from inside the organization's codebase, or from open-source code.
\ \
‣ **Implement 💎 ([`/implement`](https://pr-agent-docs.codium.ai/tools/implement/))**: Generates implementation code from review suggestions. ‣ **Implement 💎 ([`/implement`](https://qodo-merge-docs.qodo.ai/tools/implement/))**: Generates implementation code from review suggestions.
___ ___
## Example results ## Example results

16
docs/docs/tools/implement.md
View File

@ -1,12 +1,12 @@
## Overview ## Overview
The `implement` tool automatically generates implementation code based on PR review suggestions. The `implement` tool converts human code review discussions and feedback into ready-to-commit code changes.
It combines LLM capabilities with PR review suggestions to help developers implement code changes quickly and with confidence. It leverages LLM technology to transform PR comments and review suggestions into concrete implementation code, helping developers quickly turn feedback into working solutions.
## Usage Scenarios ## Usage Scenarios
### 1. For Reviewers ### For Reviewers
Reviewers can request code changes by: <br> Reviewers can request code changes by: <br>
1. Selecting the code block to be modified. <br> 1. Selecting the code block to be modified. <br>
@ -15,10 +15,10 @@ Reviewers can request code changes by: <br>
/implement <code-change-description> /implement <code-change-description>
``` ```
![implement1](https://codium.ai/images/pr_agent/implement1.png){width=512} ![implement1](https://codium.ai/images/pr_agent/implement1.png){width=640}
### 2. For PR Authors ### For PR Authors
PR authors can implement suggested changes by replying to a review comment using either: <br> PR authors can implement suggested changes by replying to a review comment using either: <br>
1. Add specific implementation details as described above 1. Add specific implementation details as described above
@ -30,16 +30,16 @@ PR authors can implement suggested changes by replying to a review comment using
/implement /implement
``` ```
![implement2](https://codium.ai/images/pr_agent/implement2.png){width=512} ![implement2](https://codium.ai/images/pr_agent/implement2.png){width=640}
### 3. For Referencing Comments ### For Referencing Comments
You can reference and implement changes from any comment by: You can reference and implement changes from any comment by:
``` ```
/implement <link-to-review-comment> /implement <link-to-review-comment>
``` ```
![implement3](https://codium.ai/images/pr_agent/implement3.png){width=512} ![implement3](https://codium.ai/images/pr_agent/implement3.png){width=640}
Note that the implementation will occur within the review discussion thread. Note that the implementation will occur within the review discussion thread.

7
docs/docs/usage-guide/changing_a_model.md
View File

@ -40,7 +40,7 @@ E.g. to use a new model locally via Ollama, set in `.secrets.toml` or in a confi
model = "ollama/qwen2.5-coder:32b" model = "ollama/qwen2.5-coder:32b"
fallback_models=["ollama/qwen2.5-coder:32b"] fallback_models=["ollama/qwen2.5-coder:32b"]
custom_model_max_tokens=128000 # set the maximal input tokens for the model custom_model_max_tokens=128000 # set the maximal input tokens for the model
duplicate_examples=true # will duplicate the examples in the prompt, to help the model to output structured output duplicate_examples=true # will duplicate the examples in the prompt, to help the model to generate structured output
[ollama] [ollama]
api_base = "http://localhost:11434" # or whatever port you're running Ollama on api_base = "http://localhost:11434" # or whatever port you're running Ollama on
@ -48,11 +48,14 @@ api_base = "http://localhost:11434" # or whatever port you're running Ollama on
!!! note "Local models vs commercial models" !!! note "Local models vs commercial models"
Qodo Merge is compatible with almost any AI model, but analyzing complex code repositories and pull requests requires a model specifically optimized for code analysis. Qodo Merge is compatible with almost any AI model, but analyzing complex code repositories and pull requests requires a model specifically optimized for code analysis.
Commercial models such as GPT-4, Claude Sonnet, and Gemini have demonstrated robust capabilities in generating structured output for code analysis tasks with large input. In contrast, most open-source models currently available (as of January 2025) face challenges with these complex tasks. Commercial models such as GPT-4, Claude Sonnet, and Gemini have demonstrated robust capabilities in generating structured output for code analysis tasks with large input. In contrast, most open-source models currently available (as of January 2025) face challenges with these complex tasks.
Based on our testing, local open-source models are suitable for experimentation and learning purposes, but they are not suitable for production-level code analysis tasks. Based on our testing, local open-source models are suitable for experimentation and learning purposes, but they are not suitable for production-level code analysis tasks.
Hence, for production workflows and real-world usage, we recommend using commercial models. Hence, for production workflows and real-world usage, we recommend using commercial models.
### Hugging Face Inference Endpoints ### Hugging Face
To use a new model with Hugging Face Inference Endpoints, for example, set: To use a new model with Hugging Face Inference Endpoints, for example, set:
``` ```