Skip to content

chore(EC-1852): trim AGENTS.md to follow agentic SDLC best practices#1734

Open
joejstuart wants to merge 1 commit into
conforma:mainfrom
joejstuart:EC-1784
Open

chore(EC-1852): trim AGENTS.md to follow agentic SDLC best practices#1734
joejstuart wants to merge 1 commit into
conforma:mainfrom
joejstuart:EC-1784

Conversation

@joejstuart
Copy link
Copy Markdown
Contributor

Summary

  • Reduces AGENTS.md from 246 to 66 lines following the wg-agentic-sdlc repo scaffolding best practices
  • Removes content agents can discover on their own: directory listings, file-by-file descriptions, standard OPA conventions, repeated command blocks, generic security boilerplate
  • Keeps only what prevents agent mistakes: 100% coverage requirement, METADATA annotation format, make fmt/make generate-docs workflow, collection membership requirement, SLSA dual-format guidance, effective_on date semantics
  • Adds common change patterns table for quick orientation

Jira: https://redhat.atlassian.net/browse/EC-1852

Test plan

  • Verify make ci still passes (no policy/test changes)
  • Confirm AGENTS.md is under 150-line recommended target
  • Validate content against litmus test: "Would removing this cause an agent to make a mistake?"

🤖 Generated with Claude Code

Reduce from 246 to 66 lines by removing content agents can discover on
their own (directory listings, standard conventions, repeated commands)
and keeping only what prevents mistakes: coverage requirements, annotation
format, collection membership, SLSA dual-format, effective_on dates.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 21, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Enterprise

Run ID: 9db1be17-114a-470a-ab70-812c0166c776

📥 Commits

Reviewing files that changed from the base of the PR and between 984deaf and 9db8b60.

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

📝 Walkthrough

Walkthrough

AGENTS.md is rewritten to consolidate the repository developer guide from a detailed multi-section format into a compact, policy-focused reference. Build and test instructions are condensed with fewer make targets; development conventions are formalized covering test coverage, formatting, docs, and tool pinning; policy structure is explained via a compact annotation example; architecture guidance emphasizes collections and SLSA normalization; and change patterns plus PR conventions are added to guide common modifications and submissions.

Changes

Developer Guidance Consolidation

Layer / File(s) Summary
Build, test, and development conventions
AGENTS.md
"Build & Test" section consolidates test/build instructions with updated make targets and CLI examples; "Key Conventions" adds enforcement requirements for .rego coverage, formatting, doc generation, pinned tool execution, and conditional network isolation behavior.
Policy structure and architecture
AGENTS.md
"Policy Annotations" section shortens guidance and provides a compact METADATA block example with make conventions-check enforcement; "Architecture" section reworks guidance to emphasize policy collections, SLSA v0.2 vs. v1.0 normalization via policy/lib/tekton/, and clarifies effective_on dates as warnings in example data.
Change patterns and PR submission
AGENTS.md
New "Common Change Patterns" table maps change types to required directories and checklist items (collections/rules, library tests, wiring); "PR Conventions" section updates guidance to focus on conventional commits, make ci, and documents specific workflow files for CI and main-branch bundle publishing.

🎯 2 (Simple) | ⏱️ ~10 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and specifically summarizes the main change: trimming AGENTS.md to follow agentic SDLC best practices, with a reference to the Jira ticket.
Description check ✅ Passed The description is directly related to the changeset, providing clear details about what was removed, what was kept, and the rationale behind the changes.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

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

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@codecov
Copy link
Copy Markdown

codecov Bot commented May 21, 2026

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.

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

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant