docs(#1760): add effective_on review checklist to AGENTS.md#1761
docs(#1760): add effective_on review checklist to AGENTS.md#1761fullsend-ai-coder[bot] wants to merge 1 commit into
Conversation
Add a "Review Checklist for New Policy Rules" section to AGENTS.md with two items: (1) new deny/warn rules must include an effective_on date in their rule data to provide a migration window before enforcement, and (2) new rules must be added to the appropriate collection(s). This ensures the review agent flags missing effective_on dates on future PRs, addressing the gap identified when PR #1736 was merged without one. Closes #1760
|
🤖 Finished Review · ✅ Success · Started 2:46 PM UTC · Completed 2:57 PM UTC |
ReviewFindingsMedium
Labels: PR modifies documentation (AGENTS.md) and requires manual review due to protected path |
| `effective_on` date in their rule data entry (in `example/data/`) to | ||
| provide a migration window. Rules without `effective_on` enforce | ||
| immediately on deployment, which can break existing builds without | ||
| warning. Check that the corresponding rule data file has a future |
There was a problem hiding this comment.
[medium] Technical accuracy in documentation
The checklist incorrectly directs reviewers to check the corresponding rule data file in example/data/ for the effective_on date. The effective_on that controls deny-vs-warn behavior comes from METADATA annotations in .rego files (via lib.time.when(chain)), not from data files. Over 20 existing rules use # custom: effective_on: in their METADATA block. The data-level effective_on in example/data/ serves a different purpose (data versioning). This will lead reviewers to check the wrong location.
Suggested fix: Rewrite to distinguish two mechanisms: (1) New .rego deny/warn rules must include a future effective_on in their METADATA annotation (# custom: effective_on: ). (2) New data entries in example/data/ should include effective_on for versioning.
Add a "Review Checklist for New Policy Rules" section to AGENTS.md with two items: (1) new deny/warn rules must include an effective_on date in their rule data to provide a migration window before enforcement, and (2) new rules must be added to the appropriate collection(s). This ensures the review agent flags missing effective_on dates on future PRs, addressing the gap identified when PR #1736 was merged without one.
Closes #1760
Post-script verification
agent/1760-add-effective-on-checklist)97efaf301694a04d7c7b4355484cf9aa658a470b..HEAD)