docs: add AGENTS.md for cross-agent project guidance#198
Merged
scottschreckengaust merged 6 commits intomainfrom Apr 23, 2026
Merged
docs: add AGENTS.md for cross-agent project guidance#198scottschreckengaust merged 6 commits intomainfrom
scottschreckengaust merged 6 commits intomainfrom
Conversation
github-actions
Bot
added
the
documentation
scottschreckengaust
changed the title
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
scottschreckengaust
changed the title
scottschreckengaust
requested review from
a team,
Kalindi-Dev,
harmjeff,
raj-jain-aws,
scoropeza and
spraja08
leandrodamascena
requested changes
Apr 23, 2026
Contributor
leandrodamascena
left a comment
leandrodamascena
left a comment
There was a problem hiding this comment.
I left some comments.
Follows the open AGENTS.md format (https://agents.md/) to provide a single, predictable file that any AI coding agent can use to understand project conventions, build commands, and PR requirements.
Expand AGENTS.md with docs/ structure, key documentation links, full markdownlint rule coverage, security scanner table with suppression patterns, and CHANGELOG constraint. Add .claude/CLAUDE.md for Claude Code-specific project instructions (attribution settings, evaluator workflow, context-aware doc pointers). Whitelist .claude/CLAUDE.md in .gitignore.
Move context-aware doc pointers and writing-inputs reference into AGENTS.md where all agents benefit. Slim CLAUDE.md to only the Claude Code-specific settings.json attribution config.
The contributor statement is in AGENTS.md and settings.json is self-describing. No Claude-specific instructions remain that aren't already agent-agnostic.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Fix workflow count (6→8), correct writing-inputs description, wrap bare commands in fenced code blocks, remove non-existent .github/instructions/ reference, and update .github/ tree to reflect current repo state (dependabot, CODEOWNERS, ISSUE_TEMPLATE).
scottschreckengaust
force-pushed
the
add-agents-md
branch
from
9635515 to
36b1dba
Compare
leandrodamascena
approved these changes
Apr 23, 2026
Contributor
leandrodamascena
left a comment
leandrodamascena
left a comment
There was a problem hiding this comment.
Thanks for working on the feedback @scottschreckengaust. Approved.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds an
AGENTS.mdfile following the open AGENTS.md format — a standardized, agent-agnostic way to provide project context to AI coding agents.Changes
AGENTS.md(project root)Cross-agent guidance for any tool supporting the AGENTS.md format (Codex, Jules,
Cursor, Aider, Gemini CLI, GitHub Copilot, and
many others):
docs/,.github/,.claude/)User experience
Before: Agents working on this repo had no standardized guidance file. They relied on reading CONTRIBUTING.md, README.md, and discovering conventions through trial and error (e.g., missing the contributor statement, not knowing about security scanners).
After: Any agent supporting the AGENTS.md format automatically picks up project conventions, security scanner guidance, and documentation pointers.
Checklist
Test Plan
npx markdownlint-cli2 "AGENTS.md"passes with 0 errorsBy submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of the project license.