Skip to content

Add AGENTS.md with agent guidance, and CLAUDE.md to load it - #187

Merged
shawnburke merged 1 commit into
mainfrom
shawn/agents-md
Nov 9, 2026
Merged

shawnburke merged 1 commit into
mainfrom
shawn/agents-md

Conversation

@shawnburke

Copy link
Copy Markdown
Collaborator

Summary

Adds repo-level guidance for AI coding agents:

  • Comments and PR content: never include customer names or identifiers; always anonymize references.
  • Architecture notes: snyk-broker always runs in websocket mode, and data transport never uses long polling.

Most agent tools read AGENTS.md directly. Claude Code reads CLAUDE.md, which here only imports AGENTS.md (@AGENTS.md), so both get the same rules from one file.

Test plan

  • Docs only; no code changes

🤖 Generated with Claude Code

AGENTS.md is read directly by most agent tools; Claude Code reads
CLAUDE.md, which imports it so both see the same rules.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

@akwirick akwirick 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.

We probably want a bit more I'm guessing but it's a start

@shawnburke
shawnburke merged commit 65d4945 into main Nov 9, 2026
27 of 28 checks passed
@shawnburke
shawnburke deleted the shawn/agents-md branch November 9, 2026 22:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants