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

Merged

Youw merged 1 commit from add-agents-md into master

2026-06-14 06:17:34 -05:00

Youw commented

2026-06-14 06:00:16 -05:00

(Migrated from github.com)

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

## 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