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

Merge pull request #1835 from qodo-ai/of/chat-to-implement

Browse Source 
docs: add dedicated "Chat on code suggestions" core ability
This commit is contained in:
ofir-frd
2025-05-28 11:07:50 +03:00
committed by GitHub
parent 95e4604abe fd1a27c2ac
commit b802b162d1
5 changed files with 84 additions and 66 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -7,50 +7,50 @@ It leverages LLM technology to transform PR comments and review suggestions into
## Usage Scenarios
### For Reviewers
=== "For Reviewers"
Reviewers can request code changes by:
Reviewers can request code changes by:
1. Selecting the code block to be modified.
2. Adding a comment with the syntax:
1. Selecting the code block to be modified.
2. Adding a comment with the syntax:
```
/implement <code-change-description>
```
```
/implement <code-change-description>
```
![implement1](https://codium.ai/images/pr_agent/implement1.png){width=640}
![implement1](https://codium.ai/images/pr_agent/implement1.png){width=640}
### 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:
1. Add specific implementation details as described above
1. Add specific implementation details as described above
```
/implement <code-change-description>
```
```
/implement <code-change-description>
```
2. Use the original review comment as instructions
2. Use the original review comment as instructions
```
/implement
```
```
/implement
```
![implement2](https://codium.ai/images/pr_agent/implement2.png){width=640}
![implement2](https://codium.ai/images/pr_agent/implement2.png){width=640}
### 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=640}
![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.
**Configuration options**
## Configuration options
- Use `/implement` to implement code change within and based on the review discussion.
- Use `/implement <code-change-description>` inside a review discussion to implement specific instructions.

39
docs/docs/tools/improve.md
View File

@ -288,45 +288,6 @@ We advise users to apply critical analysis and judgment when implementing the pr
In addition to mistakes (which may happen, but are rare), sometimes the presented code modification may serve more as an _illustrative example_ than a directly applicable solution.
In such cases, we recommend prioritizing the suggestion's detailed description, using the diff snippet primarily as a supporting reference.
### Chat on code suggestions
> `💎 feature` Platforms supported: GitHub, GitLab
Qodo Merge implements an orchestrator agent that enables interactive code discussions, listening and responding to comments without requiring explicit tool calls.
The orchestrator intelligently analyzes your responses to determine if you want to implement a suggestion, ask a question, or request help, then delegates to the appropriate specialized tool.
#### Setup and Activation
Enable interactive code discussions by adding the following to your configuration file (default is `True`):
```toml
[pr_code_suggestions]
enable_chat_in_code_suggestions = true
```
!!! info "Activating Dynamic Responses"
To obtain dynamic responses, the following steps are required:
1. Run the `/improve` command (mostly automatic)
2. Tick the `/improve` recommendation checkboxes (_Apply this suggestion_) to have Qodo Merge generate a new inline code suggestion discussion
3. The orchestrator agent will then automatically listen and reply to comments within the discussion without requiring additional commands
#### Explore the available interaction patterns:
!!! tip "Tip: Direct the agent with keywords"
Use "implement" or "apply" for code generation. Use "explain", "why", or "how" for information and help.
=== "Asking for Details"
![Chat on code suggestions ask](https://codium.ai/images/pr_agent/improve_chat_on_code_suggestions_ask.png){width=512}
=== "Implementing Suggestions"
![Chat on code suggestions implement](https://codium.ai/images/pr_agent/improve_chat_on_code_suggestions_implement.png){width=512}
=== "Providing Additional Help"
![Chat on code suggestions help](https://codium.ai/images/pr_agent/improve_chat_on_code_suggestions_help.png){width=512}
### Dual publishing mode
Our recommended approach for presenting code suggestions is through a [table](https://qodo-merge-docs.qodo.ai/tools/improve/#overview) (`--pr_code_suggestions.commitable_code_suggestions=false`).