ti.sil/pr-agent
1
0
Fork 0
mirror of https://github.com/qodo-ai/pr-agent.git synced 2025-12-12 10:55:17 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: add file organization tips to hierarchical best practices and compliance documentation

Browse source
This commit is contained in:
ofir-frd 2025-07-26 08:54:23 +03:00
parent 6e543da4b4
commit 86847c40ff
2 changed files with 9 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/docs/tools/compliance.md
View file

@ -177,6 +177,10 @@ pr-agent-settings/
└── ... # More repositories └── ... # More repositories
``` ```
???+ tip "Tip: Groups and files"
- Each folder (including the global folder) can contain a single `pr_compliance_checklist.yaml` file
- Organize repository compliance checklists by creating subfolders within the `groups` folder. Group them by purpose, programming languages, or other categories
3\. Define the metadata file `metadata.yaml` in the root of `pr-agent-settings`: 3\. Define the metadata file `metadata.yaml` in the root of `pr-agent-settings`:
```yaml ```yaml

5
docs/docs/tools/improve.md
View file

@ -156,6 +156,7 @@ Qodo Merge supports both simple and hierarchical best practices configurations t
- Keep each file relatively short, under 800 lines, since: - Keep each file relatively short, under 800 lines, since:
- 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
- Maximum multiple file accumulated content is limited to 2000 lines.
- Use pattern-based structure rather than simple bullet points for better clarity - Use pattern-based structure rather than simple bullet points for better clarity
???- tip "Example of a best practices file" ???- tip "Example of a best practices file"
@ -251,6 +252,10 @@ For organizations managing multiple repositories with different requirements, Qo
└── ... # More repositories └── ... # More repositories
``` ```
???+ tip "Tip: Groups and files"
- Each folder (including the global folder) can contain a single `best_practices.md` file
- Organize repository best practices by creating subfolders within the `groups` folder. Group them by purpose, programming languages, or other categories
3\. Define the metadata file `metadata.yaml` that maps your repositories to their relevant best practices paths, for example: 3\. Define the metadata file `metadata.yaml` that maps your repositories to their relevant best practices paths, for example:
```yaml ```yaml