mirror of
https://github.com/qodo-ai/pr-agent.git
synced 2025-07-04 12:50:38 +08:00
docs: Enhance /implement tool documentation with usage scenarios and examples
This commit is contained in:
@ -4,19 +4,53 @@ The `implement` tool automatically generates implementation code based on PR rev
|
|||||||
It combines LLM capabilities with static code analysis to help developers implement code changes quickly and with confidence.
|
It combines LLM capabilities with static code analysis to help developers implement code changes quickly and with confidence.
|
||||||
|
|
||||||
|
|
||||||
To use the tool, manually invoke it by commenting in any PR discussion that contains code suggestions:
|
## Usage Scenarios
|
||||||
```
|
|
||||||
/implement
|
|
||||||
```
|
|
||||||
|
|
||||||
## Example usage
|
|
||||||
|
|
||||||
Invoke the tool manually by commenting `/implement` on any PR review discussion.
|
### 1. For Reviewers
|
||||||
The tool will generate code implementation for the selected discussion:
|
|
||||||
|
Reviewers can request code changes by: <br>
|
||||||
|
1. Selecting the code block to be modified. <br>
|
||||||
|
2. Adding a comment with the syntax:
|
||||||
|
```
|
||||||
|
/implement <code-change-description>
|
||||||
|
```
|
||||||
|
|
||||||
{width=768}
|
{width=768}
|
||||||
|
|
||||||
|
|
||||||
|
### 2. For PR Authors
|
||||||
|
|
||||||
|
PR authors can implement suggested changes by replying to a review comment using either: <br>
|
||||||
|
1. Add specific implementation details as described above
|
||||||
|
```
|
||||||
|
/implement <code-change-description>
|
||||||
|
```
|
||||||
|
2. Use the original review comment as instructions
|
||||||
|
```
|
||||||
|
/implement
|
||||||
|
```
|
||||||
|
|
||||||
|
{width=768}
|
||||||
|
|
||||||
|
|
||||||
|
### 3. For Referencing Comments
|
||||||
|
|
||||||
|
You can reference and implement changes from any comment by:
|
||||||
|
```
|
||||||
|
/implement <link-to-review-comment>
|
||||||
|
```
|
||||||
|
|
||||||
|
{width=768}
|
||||||
|
|
||||||
|
Note that the implementation will occur within the review discussion thread.
|
||||||
|
Invoke the tool manually by commenting `/implement` on any PR review discussion.
|
||||||
|
|
||||||
|
|
||||||
|
**Configuration options** <br>
|
||||||
|
- Use `/implement` to implement code change within and based on the review discussion. <br>
|
||||||
|
- Use `/implement <code-change-description>` inside a review discussion to implement specific instructions. <br>
|
||||||
|
- Use `/implement <link-to-review-comment>` to indirectly call the tool from any comment. <br>
|
||||||
|
|
||||||
**Notes** <br>
|
**Notes** <br>
|
||||||
- Languages that are currently supported by the tool: Python, Java, C++, JavaScript, TypeScript, C#. <br>
|
- Languages that are currently supported by the tool: Python, Java, C++, JavaScript, TypeScript, C#.
|
||||||
- Use `/implement <discuttion comment URL>` to indirectly call the tool.
|
|
||||||
|
Reference in New Issue
Block a user