Skip to content

Add AGENTS.md for AI coding agents - #1

Merged
raf-li merged 1 commit into
mainfrom
docs/agent-instructions
Oct 2, 2026
Merged

raf-li merged 1 commit into
mainfrom
docs/agent-instructions

Conversation

@raf-li

@raf-li raf-li commented Oct 2, 2026

Copy link
Copy Markdown
Member

Adds instructions that AI coding agents read automatically in every repository created from this template.

  • AGENTS.md: the team's rules, read by Claude Code, Codex, GitHub Copilot, Cursor, Gemini and others:

    • accessibility first (labels for screen readers, keyboard-only use, clear messages),
    • never commit secrets,
    • no direct pushes to main, and ask before publishing or destructive actions,
    • never post in other people's repositories on the team's behalf (NV Access bans AI tools from the NVDA Add-on Store repository),
    • be transparent about AI involvement,
    • English for code and commits, the team's language for conversation.

    It also has sections to fill in with each project's own description, commands and notes.

  • CLAUDE.md: a single @AGENTS.md line, so Claude Code loads the same file and there is one source of truth.

  • README: mentions both, and no longer asks to have main protected by hand, since the organization now does it automatically.

🤖 Generated with Claude Code

AGENTS.md holds the team's rules for any AI coding agent (Claude Code,
Codex, Copilot, Cursor, Gemini, ...): accessibility first, no committed
secrets, no direct pushes to main, ask before publishing or destructive
actions, never post in other people's repositories (NV Access bans AI
tools from the Add-on Store repository), and stay transparent about AI
involvement. It has sections to fill in with the project's own commands
and notes. CLAUDE.md just imports it, so there is one source of truth.

The README mentions both, and no longer asks to have the main branch
protected by hand: the organization does that automatically now.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@raf-li
raf-li merged commit 31077ba into main Oct 2, 2026
1 check passed
@raf-li
raf-li deleted the docs/agent-instructions branch October 2, 2026 05:37
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.

1 participant