Skip to content

docs: add AGENTS.md + cleanup#491

Merged
kehoecj merged 3 commits into
mainfrom
docs/add-agents-md
May 22, 2026
Merged

docs: add AGENTS.md + cleanup#491
kehoecj merged 3 commits into
mainfrom
docs/add-agents-md

Conversation

@kehoecj
Copy link
Copy Markdown
Collaborator

@kehoecj kehoecj commented May 22, 2026

Adds AGENTS.md — a cross-platform project context file that AI coding agents (Claude Code, Codex, Kiro, etc.) read automatically when working in this repo.

What's in it

  • Project architecture and data flow overview
  • Full local CI pipeline (replicates what GitHub Actions runs)
  • Step-by-step recipes for adding a new validator or reporter
  • PR requirements (CHANGELOG, conventional commits, coverage threshold)
  • golangci-lint pitfalls that commonly trip up contributors
  • Dependency policy, security constraints, testing patterns
  • Documentation site build instructions
  • MegaLinter and OpenSSF Scorecard guidance

Also included

  • README.md: Fix inconsistent install section headings (bold text vs h3 inside <details>)
  • CONTRIBUTING.md: Add pointer to AGENTS.md as a quick-start reference
  • website/.npmrc: Pin npm registry to public npmjs.org to prevent internal registry URLs leaking into package-lock.json

Why

Contributors using AI tools currently get no project-specific guidance — the agent has to reverse-engineer patterns by reading multiple files. This gives it the full picture upfront, which means fewer broken PRs and less reviewer back-and-forth on things like missing CHANGELOG entries, wrong import ordering, or forgetting to register a file type in all three places.

@kehoecj kehoecj requested a review from a team as a code owner May 22, 2026 18:30
@kehoecj kehoecj added the no changelog Do not require a CHANGELOG update for MR's. Mostly used for dependably label May 22, 2026
@kehoecj kehoecj merged commit d2cb9bb into main May 22, 2026
19 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

no changelog Do not require a CHANGELOG update for MR's. Mostly used for dependably

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant