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: update hierarchical repository examples with generic naming conventions

Browse source
This commit is contained in:
ofir-frd 2025-08-29 15:43:54 +03:00
parent 03832818e6
commit a53a9358ed
2 changed files with 26 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -181,17 +181,19 @@ pr-agent-settings/
│ ├── cpp_repos/
│ │ └── pr_compliance_checklist.yaml
│ └── ...
├── qodo-merge/ # For standalone repositories
├── repo_a/ # For standalone repositories
│ └── pr_compliance_checklist.yaml
├── qodo-monorepo/ # For monorepo-specific compliance
├── monorepo-name/ # For monorepo-specific compliance
│ ├── pr_compliance_checklist.yaml # Root-level monorepo compliance
│ ├── qodo-github/ # Subproject compliance
│ ├── service-a/ # Subproject compliance
│ │ └── pr_compliance_checklist.yaml
│ └── qodo-gitlab/ # Another subproject
│ └── service-b/ # Another subproject
│ └── pr_compliance_checklist.yaml
└── ... # More repositories
```
> **Note:** In this structure, `pr-agent-settings`, `codebase_standards`, `global`, `groups`, `metadata.yaml`, and `pr_compliance_checklist.yaml` are hardcoded names that must be used exactly as shown. All other names (such as `frontend_repos`, `backend_repos`, `repo_a`, `monorepo-name`, `service-a`, etc.) are examples and should be replaced with your actual repository and service names.
???+ tip "Grouping and categorizing compliance checklists"
- 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
@ -200,9 +202,9 @@ pr-agent-settings/
```yaml
# Standalone repos
qodo-merge:
repo_a:
pr_compliance_checklist_paths:
- "qodo-merge"
- "repo_a"
# Group-associated repos
repo_b:
@ -216,16 +218,16 @@ repo_c:
- "groups/backend_repos"
# Monorepo with subprojects
qodo-monorepo:
monorepo-name:
pr_compliance_checklist_paths:
- "qodo-monorepo"
- "monorepo-name"
monorepo_subprojects:
frontend:
pr_compliance_checklist_paths:
- "qodo-monorepo/qodo-github"
- "monorepo-name/service-a"
backend:
pr_compliance_checklist_paths:
- "qodo-monorepo/qodo-gitlab"
- "monorepo-name/service-b"
```
4\. Set the following configuration:

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

@ -241,17 +241,19 @@ For organizations managing multiple repositories with different requirements, Qo
│ ├── cpp_repos/
│ │ └── best_practices.md
│ └── ...
├── qodo-merge/ # For standalone repositories
├── repo_a/ # For standalone repositories
│ └── best_practices.md
├── qodo-monorepo/ # For monorepo-specific rules
├── monorepo-name/ # For monorepo-specific rules
│ ├── best_practices.md # Root level monorepo rules
│ ├── qodo-github/ # Subproject best practices
│ ├── service-a/ # Subproject best practices
│ │ └── best_practices.md
│ └── qodo-gitlab/ # Another subproject
│ └── service-b/ # Another subproject
│ └── best_practices.md
└── ... # More repositories
```
> **Note:** In this structure, `pr-agent-settings`, `codebase_standards`, `global`, `groups`, `metadata.yaml`, and `best_practices.md` are hardcoded names that must be used exactly as shown. All other names (such as `frontend_repos`, `backend_repos`, `repo_a`, `monorepo-name`, `service-a`, etc.) are examples and should be replaced with your actual repository and service names.
???+ tip "Grouping and categorizing best practices"
- 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
@ -260,9 +262,9 @@ For organizations managing multiple repositories with different requirements, Qo
```yaml
# Standalone repos
qodo-merge:
repo_a:
best_practices_paths:
- "qodo-merge"
- "repo_a"
# Group-associated repos
repo_b:
@ -276,16 +278,16 @@ For organizations managing multiple repositories with different requirements, Qo
- "groups/backend_repos"
# Monorepo with subprojects
qodo-monorepo:
monorepo-name:
best_practices_paths:
- "qodo-monorepo"
- "monorepo-name"
monorepo_subprojects:
qodo-github:
service-a:
best_practices_paths:
- "qodo-monorepo/qodo-github"
qodo-gitlab:
- "monorepo-name/service-a"
service-b:
best_practices_paths:
- "qodo-monorepo/qodo-gitlab"
- "monorepo-name/service-b"
```
4\. Set the following configuration in your global configuration file: