mirror of
https://github.com/qodo-ai/pr-agent.git
synced 2025-12-12 10:55:17 +00:00
docs: update explanation of auto and custom best practices integration
This commit is contained in:
parent
1fff1b0208
commit
ae4c8f85f9
1 changed files with 2 additions and 6 deletions
|
|
@ -41,13 +41,9 @@ When presenting the suggestions generated by the `improve` tool, Qodo Merge will
|
|||
|
||||
Teams and companies can also manually define their own [custom best practices](https://qodo-merge-docs.qodo.ai/tools/improve/#best-practices) in Qodo Merge.
|
||||
|
||||
When custom best practices exist, Qodo Merge will still generate an 'auto best practices' wiki file, though it won't be used by the `improve` tool.
|
||||
However, this auto-generated file can still serve two valuable purposes:
|
||||
When custom best practices exist, Qodo Merge will use both the auto-generated best practices and your custom best practices together. The auto best practices file provides additional insights derived from suggestions your team found valuable enough to implement, while also demonstrating effective patterns for writing AI-friendly best practices.
|
||||
|
||||
1. It can help enhance your custom best practices with additional insights derived from suggestions your team found valuable enough to implement
|
||||
2. It demonstrates effective patterns for writing AI-friendly best practices
|
||||
|
||||
Even when using custom best practices, we recommend regularly reviewing the auto best practices file to refine your custom rules.
|
||||
We recommend utilizing both auto and custom best practices to get the most comprehensive code improvement suggestions for your team.
|
||||
|
||||
## Relevant configurations
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue