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

docs: improve compliance checklist field definitions and terminology clarity

Browse source
This commit is contained in:
ofir-frd 2025-08-03 10:05:49 +03:00
parent a23b527101
commit 5d50cfcb34
1 changed files with 7 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -111,9 +111,11 @@ Validates against an organization-specific compliance checklist:
Each compliance is defined in a YAML file as follows: Each compliance is defined in a YAML file as follows:
- `title`: Used to provide a clear name for the compliance - `title` (required): A clear, descriptive title that identifies what is being checked
- `compliance_label`: Used to automatically generate labels for non-compliance issues - `compliance_label` (required): Determines whether this compliance generates labels for non-compliance issues (set to `true` or `false`)
- `objective`, `success_criteria`, and `failure_criteria`: These fields are used to clearly define what constitutes compliance - `objective` (required): A detailed description of the goal or purpose this compliance aims to achieve
- `success_criteria` and `failure_criteria` (at least one required; both recommended): Define the conditions for compliance
???+ tip "Example of a compliance checklist" ???+ tip "Example of a compliance checklist"
@ -137,9 +139,9 @@ Each compliance is defined in a YAML file as follows:
### Local Compliance Checklists ### Local Compliance Checklists
For basic usage, create a `pr_compliance_checklist.yaml` file in your repository's root directory containing the compliance rules specific to your repository. For basic usage, create a `pr_compliance_checklist.yaml` file in your repository's root directory containing the compliance requirements specific to your repository.
The AI model will use this `pr_compliance_checklist.yaml` file as a reference, and if the PR code violates any of the rules, it will be shown in the compliance tool's comment. The AI model will use this `pr_compliance_checklist.yaml` file as a reference, and if the PR code violates any of the compliance requirements, it will be shown in the compliance tool's comment.
### Global Hierarchical Compliance ### Global Hierarchical Compliance