Skip to content

docs(#1818): add opt-in/fail-closed exception to effective_on guidance - #1819

Open
fullsend-ai-coder[bot] wants to merge 1 commit into
mainfrom
agent/1818-effective-on-opt-in-exception
Open

docs(#1818): add opt-in/fail-closed exception to effective_on guidance#1819
fullsend-ai-coder[bot] wants to merge 1 commit into
mainfrom
agent/1818-effective-on-opt-in-exception

Conversation

@fullsend-ai-coder

Copy link
Copy Markdown
Contributor

What:

Add an exception clause to the effective_on review checklist guidance in AGENTS.md. Rules that are both opt-in (require explicit user configuration to activate) and fail-closed (produce no output when unconfigured) may now omit effective_on, provided the PR description documents the rationale.

Why:

The current effective_on guidance applies a blanket "MUST" to all new deny/warn rules, but rules that are opt-in and fail-closed cannot break existing builds by definition — unconfigured builds are completely unaffected. This caused a false positive on PR #1787, where the signature_verification warn rule was correctly designed as opt-in/fail-closed but was flagged for missing effective_on. As more opt-in verification rules are added (e.g., for other artifact types), this exception avoids repeated case-by-case justification while preserving the safety guarantee for mandatory enforcement rules.

Tickets:


Closes #1818

Post-script verification

  • Branch is not main/master (agent/1818-effective-on-opt-in-exception)
  • Secret scan passed (gitleaks — ed6e226dd8c57d75be267d34f3f8bf0bb412feb0..HEAD)
  • PR body secret scan passed (gitleaks — no-git)

Add an exception clause to the effective_on review checklist item in
AGENTS.md. Rules that are both opt-in (require explicit user
configuration to activate) and fail-closed (produce no output when
unconfigured) may omit effective_on, since unconfigured builds are
unaffected. When omitting effective_on for this reason, the PR
description must document the rationale.

This addresses the false positive flagged on PR #1787, where the
signature_verification warn rule was correctly designed as opt-in
and fail-closed but was flagged for missing effective_on by the
review agent following the blanket MUST in AGENTS.md.

Closes #1818
@fullsend-ai-review

fullsend-ai-review Bot commented Aug 20, 2026

Copy link
Copy Markdown

🤖 Finished Review · ✅ Success · Started 7:50 AM UTC · Completed 7:59 AM UTC

Commit: 87c4a29 · View workflow run →

@codecov

codecov Bot commented Aug 20, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

Flag Coverage Δ
unit-tests 100.00% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@fullsend-ai-review

Copy link
Copy Markdown

Review

Findings

Medium

  • [protected-path] AGENTS.md — AGENTS.md is a protected governance file listed in the repository's protected paths. This PR modifies it to add an opt-in/fail-closed exception to the effective_on review checklist guidance. The PR links to issue Add opt-in/fail-closed exception to effective_on guidance in AGENTS.md #1818 and the description clearly explains the rationale. Human approval is always required for protected-path changes, regardless of context.

Labels: PR modifies AGENTS.md (project governance documentation)

@fullsend-ai-review fullsend-ai-review Bot added requires-manual-review Review requires human judgment documentation Improvements or additions to documentation labels Aug 20, 2026

@robnester-rh robnester-rh left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation requires-manual-review Review requires human judgment size: XS

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add opt-in/fail-closed exception to effective_on guidance in AGENTS.md

1 participant