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

docs: improve guidance on code suggestions quality in improve documentation

Browse Source
This commit is contained in:
mrT23
2025-03-07 16:51:42 +02:00
parent 61b6d1f1a3
commit c1fb76abcf
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -445,8 +445,8 @@ Note: Chunking is primarily relevant for large PRs. For most PRs (up to 500 line
## A note on code suggestions quality
- AI models for code are getting better and better, but they are not flawless. Not all the suggestions will be perfect, and a user should not accept all of them automatically. Critical reading and judgment are required.
- While mistakes of the AI are rare but can happen, a real benefit from the suggestions of the `improve` (and [`review`](https://qodo-merge-docs.qodo.ai/tools/review/)) tool is to catch, with high probability, **mistakes or bugs done by the PR author**, when they happen. So, it's a good practice to spend the needed ~30-60 seconds to review the suggestions, even if not all of them are always relevant.
- AI models for code are getting better and better, but they are not flawless. Not all the suggestions will be perfect, and a user should not accept all of them automatically. Critical reading and judgment are required. Mistakes of the AI are rare but can happen.
- The suggestions aim to enable the PR author to self-reflect on and improve their pull requests, while also alerting on any critical bugs that may have been identified. It's perfectly acceptable to implement only the suggestions you find valuable for your specific context.
- The hierarchical structure of the suggestions is designed to help the user to _quickly_ understand them, and to decide which ones are relevant and which are not:
- Only if the `Category` header is relevant, the user should move to the summarized suggestion description