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

docs: clarify guidelines on file length and specificity in improve.md

Browse Source
This commit is contained in:
mrT23
2024-09-15 08:28:01 +03:00
parent 480a025877
commit 7586514abf
1 changed files with 3 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -128,7 +128,9 @@ This file is only an example. Since it is used as a prompt for an AI model, we w
- It should be written in a clear and concise manner
- If needed, it should give short relevant code snippets as examples
- Up to 800 lines are allowed
- No more than 800 lines of text are allowed. Why:
- Very long best practices file may not be fully processed by the AI model.
- A very long file may represent a more "**generic**" set of guidelines, similar to what the AI model was already trained on. The goal here is to distill a more specific set of guidelines, that are relevant to the specific needs of the project.
Example results: