Skip to content

chore(EC-1851): trim AGENTS.md and add design docs per agentic SDLC best practices#3322

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

chore(EC-1851): trim AGENTS.md and add design docs per agentic SDLC best practices#3322
joejstuart wants to merge 1 commit into
conforma:mainfrom
joejstuart:EC-1784

Conversation

@joejstuart
Copy link
Copy Markdown
Contributor

Summary

  • Reduces AGENTS.md from 243 to 75 lines following wg-agentic-sdlc repo scaffolding best practices
  • Removes content agents discover on their own: cmd/ listing, internal/ package descriptions, rule filtering details that duplicated .cursor/rules/*.mdc
  • Keeps only what prevents mistakes: test tags with timeouts, acceptance test flags, CGO/DNS issue, /etc/hosts, macOS Podman setup, debug mode, troubleshooting
  • Adds internal/evaluator/DESIGN.md — why two PolicyResolvers, two-pass filtering design, scoring precedence, how to add filters
  • Adds internal/validate/vsa/DESIGN.md — VSA purpose, storage backend rationale, DSSE signing decision, expiration model
  • Design docs placed alongside code per Tier 2 best practices (not in .cursor/rules/)

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

Test plan

  • Verify make ci still passes (no code changes)
  • Confirm AGENTS.md is under 150-line target
  • Validate DESIGN.md content against current source (no stale references)

🤖 Generated with Claude Code

…est practices

Reduce AGENTS.md from 243 to 75 lines by removing content agents discover
on their own (directory listings, package descriptions, duplicated .cursor/rules
content). Add concise DESIGN.md files alongside the code they describe:
evaluator filtering rationale and VSA design decisions.

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

coderabbitai Bot commented May 21, 2026

Warning

Rate limit exceeded

@joejstuart has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 40 minutes and 40 seconds before requesting another review.

You’ve run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Enterprise

Run ID: b101e215-cba4-45ad-b908-128ae6ff19a4

📥 Commits

Reviewing files that changed from the base of the PR and between 8aec709 and d374871.

📒 Files selected for processing (3)
  • AGENTS.md
  • internal/evaluator/DESIGN.md
  • internal/validate/vsa/DESIGN.md
✨ 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 Δ
acceptance 55.60% <ø> (+<0.01%) ⬆️
generative 17.82% <ø> (ø)
integration 26.56% <ø> (ø)
unit 69.04% <ø> (ø)

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