From 5e53466d979d309e2021b353d11a4c60377b8f75 Mon Sep 17 00:00:00 2001 From: ofir-frd Date: Thu, 24 Jul 2025 15:28:37 +0300 Subject: [PATCH] docs: add local compliance checklists section to compliance tool documentation --- docs/docs/tools/compliance.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/docs/tools/compliance.md b/docs/docs/tools/compliance.md index 38251af5..09ef455a 100644 --- a/docs/docs/tools/compliance.md +++ b/docs/docs/tools/compliance.md @@ -134,6 +134,11 @@ Each compliance is defined in a YAML file as follows: - Use clear, actionable language that developers can understand - Focus on meaningful compliance requirements, not style preferences +### 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. + +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. ### Global Hierarchical Compliance