mirror of
https://github.com/qodo-ai/pr-agent.git
synced 2025-12-11 18:35:18 +00:00
fix(docs): update default values for help text and code suggestions in documentation
This commit is contained in:
parent
940f82b695
commit
4384740cb6
3 changed files with 35 additions and 3 deletions
|
|
@ -88,3 +88,35 @@ ___
|
|||
Note: The effort levels (1-5) are primarily meant for _comparative_ purposes, helping teams prioritize reviewing smaller PRs first. The actual review duration may vary, as the focus is on providing consistent relative effort estimates.
|
||||
|
||||
___
|
||||
|
||||
??? note "Q: How to reduce the "noise" generated by Qodo Merge?"
|
||||
#### Answer:<span style="display:none;">3</span>
|
||||
|
||||
The default configuration of Qodo Merge is designed to balance helpful feedback with noise reduction. It reduces noise through several approaches:
|
||||
|
||||
- Auto-feedback uses three highly structured tools (`/describe`, `/review`, and `/improve`), designed to be accessible at a glance without creating large visual overload
|
||||
- Suggestions are presented in a table format rather than as committable comments, which are far noisier
|
||||
- The 'File Walkthrough' section is folded by default, as it tends to be verbose
|
||||
- Intermediate comments are avoided when creating new PRs (like "Qodo Merge is now reviewing your PR..."), which would generate email noise
|
||||
|
||||
From our experience, especially in large teams or organizations, complaints about "noise" often stem from these issues:
|
||||
|
||||
- **Lack of familiarity with the tool**: When Qodo Merge is installed on a new repo without proper introduction or training, users may not understand its purpose or perceive its feedback as "criticism" rather than constructive assistance and a chance to self-reflection. We recommend reviewing [this guide](https://qodo-merge-docs.qodo.ai/tools/improve/#understanding-ai-code-suggestions) to better align expectations and understand the value of Qodo Merge's feedback.
|
||||
- **Feedback from multiple bots**: When multiple bots provide feedback on the same PR, it creates confusion and noise. We recommend using Qodo Merge as the primary feedback tool to streamline the process and reduce redundancy.
|
||||
|
||||
Therefore, at a global configuration level, we recommend using the default configuration, which is designed to reduce noise while providing valuable feedback.
|
||||
|
||||
However, if you still find the feedback too noisy, you can adjust the configuration. Since each user and team has different needs, it's definitely possible - and even recommended - to adjust configurations for specific repos as needed.
|
||||
Ways to adjust the configuration for noise reduction include for example:
|
||||
|
||||
- [Score thresholds for code suggestions](https://qodo-merge-docs.qodo.ai/tools/improve/#configuration-options)
|
||||
- [Utilizing the `extra_instructions` field for more tailored feedback](https://qodo-merge-docs.qodo.ai/tools/improve/#extra-instructions)
|
||||
- [Controlling which tools run automatically](https://qodo-merge-docs.qodo.ai/usage-guide/automations_and_usage/#github-app-automatic-tools-when-a-new-pr-is-opened)
|
||||
|
||||
Note that some users may prefer the opposite - more thorough and detailed feedback. Qodo Merge is designed to be flexible and customizable, allowing you to tailor the feedback to your team's specific needs and preferences.
|
||||
Examples of ways to increase feedback include:
|
||||
|
||||
- [`Exhaustive` code suggestions](https://qodo-merge-docs.qodo.ai/tools/improve/#controlling-suggestions-depth)
|
||||
- [Dual-publishing mode](https://qodo-merge-docs.qodo.ai/tools/improve/#dual-publishing-mode)
|
||||
- [Interactive usage](https://qodo-merge-docs.qodo.ai/core-abilities/interactivity/)
|
||||
___
|
||||
|
|
|
|||
|
|
@ -512,7 +512,7 @@ Qodo Merge uses a dynamic strategy to generate code suggestions based on the siz
|
|||
|
||||
#### 2. Generating suggestions
|
||||
|
||||
- For each chunk, Qodo Merge generates up to `pr_code_suggestions.num_code_suggestions_per_chunk` suggestions (default: 4).
|
||||
- For each chunk, Qodo Merge generates up to `pr_code_suggestions.num_code_suggestions_per_chunk` suggestions (default: 3).
|
||||
|
||||
This approach has two main benefits:
|
||||
|
||||
|
|
@ -568,7 +568,7 @@ Note: Chunking is primarily relevant for large PRs. For most PRs (up to 600 line
|
|||
</tr>
|
||||
<tr>
|
||||
<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>
|
||||
<td>If set to true, the tool will display a help text in the comment. Default is false.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><b>enable_chat_text</b></td>
|
||||
|
|
|
|||
|
|
@ -68,7 +68,7 @@ extra_instructions = "..."
|
|||
</tr>
|
||||
<tr>
|
||||
<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>
|
||||
<td>If set to true, the tool will display a help text in the comment. Default is false.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><b>num_max_findings</b></td>
|
||||
|
|
|
|||
Loading…
Reference in a new issue