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

docs: add configuration options for best practices in improve tool

Browse Source
This commit is contained in:
mrT23
2025-05-04 17:47:25 +03:00
parent e9924eab89
commit f85587fb1f
1 changed files with 12 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -157,6 +157,13 @@ Tips for writing an effective `best_practices.md` file:
- AI models may not process effectively very long documents - AI models may not process effectively very long documents
- Long files tend to contain generic guidelines already known to AI - Long files tend to contain generic guidelines already known to AI
To control the number of best practices suggestions generated by the `improve` tool, give the following configuration:
```toml
[best_practices]
num_best_practice_suggestions = 2
```
#### Local and global best practices #### Local and global best practices
By default, Qodo Merge will look for a local `best_practices.md` in the root of the relevant local repo. By default, Qodo Merge will look for a local `best_practices.md` in the root of the relevant local repo.
@ -238,6 +245,11 @@ extra_instructions = ""
max_patterns = 5 max_patterns = 5
``` ```
### Multiple best practices sources
The `improve` tool will combine best practices from all available sources - global configuration, local configuration, and auto-generated files - to provide you with comprehensive recommendations.
### Combining 'extra instructions' and 'best practices' ### Combining 'extra instructions' and 'best practices'
> `💎 feature` > `💎 feature`