Skip to content

Share AI agent contribution rules across agents via AGENTS.md#818

Merged
Youw merged 1 commit into
masterfrom
add-agents-md
Jun 14, 2026
Merged

Share AI agent contribution rules across agents via AGENTS.md#818
Youw merged 1 commit into
masterfrom
add-agents-md

Conversation

@Youw

@Youw Youw commented Jun 14, 2026

Copy link
Copy Markdown
Member

Summary

The contribution and commit rules for this repository had no single home that every AI coding agent reads. This adds AGENTS.md as the canonical source — the cross-tool standard read natively by Codex, Cursor, the GitHub Copilot coding agent, VS Code, Gemini CLI and many others — so all agents follow the same rules, above all that every commit is authored by a human (with an Assisted-by: trailer naming the assisting model).

The agents that use a dedicated file load that same single source:

  • AGENTS.md (new) — the canonical rules, in plain Markdown.
  • .claude/CLAUDE.md (new) — imports @../AGENTS.md (Claude Code's import syntax); also keeps a hidapi-specific note about attributing GitHub comments posted on a maintainer's behalf.
  • GEMINI.md (new) — imports @./AGENTS.md (Gemini CLI defaults to GEMINI.md).
  • .github/copilot-instructions.md (new) — points to AGENTS.md; the Copilot coding agent and VS Code read AGENTS.md natively.

Adapted from libusb/libusb#1842.

Assisted-by: claude-code:claude-opus-4-8

The contribution and commit rules for this repository had no single home that
every AI coding agent reads. Add AGENTS.md as the canonical source -- the
cross-tool standard read natively by Codex, Cursor, the GitHub Copilot coding
agent, Gemini CLI and others -- so all agents follow the same rules, above all
that every commit is authored by a human.

The agents that use a dedicated file load that same single source:

- .claude/CLAUDE.md imports it via Claude Code's @ syntax (and keeps the
  existing note about attributing GitHub comments posted on a maintainer's
  behalf)
- GEMINI.md imports it via Gemini CLI's @ syntax
- .github/copilot-instructions.md points to it

so there is no second copy to keep in sync.

Assisted-by: claude-code:claude-opus-4-8
@Youw Youw merged commit d677dd5 into master Jun 14, 2026
25 checks passed
@Youw Youw deleted the add-agents-md branch June 14, 2026 11:17
@mcuee mcuee added the documentation Improvements or additions to documentation label Jun 14, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants