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

s

Browse Source
This commit is contained in:
mrT23
2024-05-08 14:38:28 +03:00
parent 738eb055ff
commit 38051f79b7
1 changed files with 63 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -40,52 +40,82 @@ pr_commands = [
] ]
[pr_code_suggestions] [pr_code_suggestions]
num_code_suggestions = ... num_code_suggestions_per_chunk = ...
... ...
``` ```
- The `pr_commands` lists commands that will be executed automatically when a PR is opened. - The `pr_commands` lists commands that will be executed automatically when a PR is opened.
- The `[pr_code_suggestions]` section contains the configurations for the `improve` tool you want to edit (if any) - The `[pr_code_suggestions]` section contains the configurations for the `improve` tool you want to edit (if any)
### Extended mode
An extended mode, which does not involve PR Compression and provides more comprehensive suggestions, can be invoked by commenting on any PR by setting:
```
[pr_code_suggestions]
auto_extended_mode=true
```
(This mode is true by default).
Note that the extended mode divides the PR code changes into chunks, up to the token limits, where each chunk is handled separately (might use multiple calls to GPT-4 for large PRs).
Hence, the total number of suggestions is proportional to the number of chunks, i.e., the size of the PR.
## Configuration options ## Configuration options
!!! example "General options" !!! example "General options"
- `num_code_suggestions`: number of code suggestions provided by the 'improve' tool. Default is 4 for CLI, 0 for auto tools. <table>
- `extra_instructions`: Optional extra instructions to the tool. For example: "focus on the changes in the file X. Ignore change in ...". <tr>
- `rank_suggestions`: if set to true, the tool will rank the suggestions, based on importance. Default is false. <td><b>num_code_suggestions</b></td>
- `commitable_code_suggestions`: if set to true, the tool will display the suggestions as commitable code comments. Default is false. <td>Number of code suggestions provided by the 'improve' tool. Default is 4 for CLI, 0 for auto tools.</td>
- `persistent_comment`: if set to true, the improve comment will be persistent, meaning that every new improve request will edit the previous one. Default is false. </tr>
- `enable_help_text`: if set to true, the tool will display a help text in the comment. Default is true. <tr>
<td><b>extra_instructions</b></td>
!!! example "params for '/improve --extended' mode" <td>Optional extra instructions to the tool. For example: "focus on the changes in the file X. Ignore change in ...".</td>
</tr>
- `auto_extended_mode`: enable extended mode automatically (no need for the `--extended` option). Default is true. <tr>
- `num_code_suggestions_per_chunk`: number of code suggestions provided by the 'improve' tool, per chunk. Default is 5. <td><b>rank_suggestions</b></td>
- `rank_extended_suggestions`: if set to true, the tool will rank the suggestions, based on importance. Default is true. <td>If set to true, the tool will rank the suggestions, based on importance. Default is false.</td>
- `max_number_of_calls`: maximum number of chunks. Default is 5. </tr>
- `final_clip_factor`: factor to remove suggestions with low confidence. Default is 0.9.; <tr>
<td><b>commitable_code_suggestions</b></td>
## Extended mode <td>If set to true, the tool will display the suggestions as commitable code comments. Default is false.</td>
</tr>
An extended mode, which does not involve PR Compression and provides more comprehensive suggestions, can be invoked by commenting on any PR: <tr>
``` <td><b>persistent_comment</b></td>
/improve --extended <td>If set to true, the improve comment will be persistent, meaning that every new improve request will edit the previous one. Default is false.</td>
``` </tr>
<tr>
or by setting: <td><b>enable_help_text</b></td>
``` <td>If set to true, the tool will display a help text in the comment. Default is true.</td>
[pr_code_suggestions] </tr>
auto_extended_mode=true </table>
```
(True by default).
Note that the extended mode divides the PR code changes into chunks, up to the token limits, where each chunk is handled separately (might use multiple calls to GPT-4 for large PRs).
Hence, the total number of suggestions is proportional to the number of chunks, i.e., the size of the PR.
!!! example "params for 'extended' mode"
<table>
<tr>
<td><b>auto_extended_mode</b></td>
<td>Enable extended mode automatically (no need for the --extended option). Default is true.</td>
</tr>
<tr>
<td><b>num_code_suggestions_per_chunk</b></td>
<td>Number of code suggestions provided by the 'improve' tool, per chunk. Default is 5.</td>
</tr>
<tr>
<td><b>rank_extended_suggestions</b></td>
<td>If set to true, the tool will rank the suggestions, based on importance. Default is true.</td>
</tr>
<tr>
<td><b>max_number_of_calls</b></td>
<td>Maximum number of chunks. Default is 5.</td>
</tr>
<tr>
<td><b>final_clip_factor</b></td>
<td>Factor to remove suggestions with low confidence. Default is 0.9.</td>
</tr>
</table>
## Usage Tips ## Usage Tips
@ -110,7 +140,7 @@ Hence, the total number of suggestions is proportional to the number of chunks,
!!! tip "Review vs. Improve tools comparison" !!! tip "Review vs. Improve tools comparison"
- The [`review`](https://pr-agent-docs.codium.ai/tools/review/) tool includes a section called 'Possible issues', that also provide feedback on the PR Code. - The [review](https://pr-agent-docs.codium.ai/tools/review/) tool includes a section called 'Possible issues', that also provide feedback on the PR Code.
In this section, the model is instructed to focus **only** on [major bugs and issues](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/pr_reviewer_prompts.toml#L71). In this section, the model is instructed to focus **only** on [major bugs and issues](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/pr_reviewer_prompts.toml#L71).
- The `improve` tool, on the other hand, has a broader mandate, and in addition to bugs and issues, it can also give suggestions for improving code quality and making the code more efficient, readable, and maintainable (see [here](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/pr_code_suggestions_prompts.toml#L34)). - The `improve` tool, on the other hand, has a broader mandate, and in addition to bugs and issues, it can also give suggestions for improving code quality and making the code more efficient, readable, and maintainable (see [here](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/pr_code_suggestions_prompts.toml#L34)).
- Hence, if you are interested only in feedback about clear bugs, the `review` tool might suffice. If you want a more detailed feedback, including broader suggestions for improving the PR code, also enable the `improve` tool to run on each PR. - Hence, if you are interested only in feedback about clear bugs, the `review` tool might suffice. If you want a more detailed feedback, including broader suggestions for improving the PR code, also enable the `improve` tool to run on each PR.