Skip to content

docs: document rule data defaults guidance - #1825

Open
Labeeb2339 wants to merge 1 commit into
conforma:mainfrom
Labeeb2339:codex/1824-rule-data-defaults-docs
Open

docs: document rule data defaults guidance#1825
Labeeb2339 wants to merge 1 commit into
conforma:mainfrom
Labeeb2339:codex/1824-rule-data-defaults-docs

Conversation

@Labeeb2339

Copy link
Copy Markdown

Summary\n\n- Document the four-tier

ule_data.get() resolution order and replacement semantics.\n- Define criteria for values in the hardcoded defaults map.\n- Add a review checklist item and link to the data-source configuration docs.\n\nFixes #1824\n\n## Testing\n\n- git diff --check passed.\n- Documentation assertions for the requested hierarchy, fallback, defaults guidance, link, and checklist passed.\n- go run github.com/conforma/cli opa check ./example/data/rule_data.yml ./policy checks --strict passed.\n- opa fmt --list --fail reports the pre-existing .regal/rules/custom/prefer_parsed_blob.rego formatting issue.\n- Regal reports the pre-existing policy/lib/oci/oci.rego:10 prefer-parsed-blob violation.\n\nThis is a documentation-only change; no Rego behavior or generated docs were changed.

@coderabbitai

coderabbitai Bot commented Aug 27, 2026

Copy link
Copy Markdown

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: d5a51565-02ce-4ff2-88d9-748127bb4b09

📥 Commits

Reviewing files that changed from the base of the PR and between 613785e and a08691a.

📒 Files selected for processing (1)
  • AGENTS.md

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

AGENTS.md now documents rule_data.get(key) precedence, fallback behavior, hardcoded-default scope, and a checklist for identifying deployment-specific values.

Changes

Rule-data guidance

Layer / File(s) Summary
Document rule-data resolution and review criteria
AGENTS.md
Documents four-tier replacement precedence, empty-list fallback, hardcoded-default inclusion criteria, and review guidance for deployment-specific values.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Merge Risk: ⚪ Minimal · up to a0869

This documentation-only change does not alter product behavior, and no actionable merge-blocking risk remains after normal checks and review.

Suggested reviewers: joejstuart

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the documentation change for rule data defaults guidance.
Description check ✅ Passed The description explains the change, its purpose, linked issue, validation, and documentation-only scope. It uses Summary and Testing headings instead of the template's What and Why headings, but the …
Linked Issues check ✅ Passed The changes address issue #1824 by documenting the four-tier replacement hierarchy, hardcoded-default inclusion criteria, deployment-specific configuration guidance, the review checklist item, and the…
Out of Scope Changes check ✅ Passed The changes are limited to the requested AGENTS.md documentation. No unrelated code, behavior, or generated documentation changes are reported.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Full details: Description check

Explanation

The description explains the change, its purpose, linked issue, validation, and documentation-only scope. It uses Summary and Testing headings instead of the template's What and Why headings, but the required information is present.

Full details: Linked Issues check

Explanation

The changes address issue #1824 by documenting the four-tier replacement hierarchy, hardcoded-default inclusion criteria, deployment-specific configuration guidance, the review checklist item, and the data-source documentation link.

Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands.

@fullsend-ai-review

fullsend-ai-review Bot commented Aug 27, 2026

Copy link
Copy Markdown

🤖 Finished Review · ✅ Success · Started 5:32 AM UTC · Completed 5:45 AM UTC

Commit: 87c4a29 · View workflow run →

Runtime: claude · Model: opus → claude-opus-4-6 · Effort: high · Cost: $3.39

@fullsend-ai-review

Copy link
Copy Markdown

Review

Findings

Medium

  • [protected-path] AGENTS.md — This PR modifies AGENTS.md, which is a protected governance file. The change is well-motivated by issue Document rule_data defaults inclusion criteria and priority hierarchy in AGENTS.md #1824 (adding review guidance to prevent future agent failures on rule_data defaults changes) and correctly scoped to the three items requested: the 4-tier rule_data.get() resolution hierarchy, hardcoded defaults inclusion criteria, and a review checklist item. The documented resolution order was verified against the actual get() implementation in policy/lib/rule_data/rule_data.rego (lines 192–210) and is technically accurate. Human approval is always required for protected-path changes, regardless of context.

@fullsend-ai-review fullsend-ai-review Bot added the requires-manual-review Review requires human judgment label Aug 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

requires-manual-review Review requires human judgment size: XS

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant