Skip to content

docs: Add AGENTS.md and CLAUDE.md agent guidance - #71

Merged
richardcase merged 2 commits into
mainfrom
agents
Oct 27, 2026
Merged

richardcase merged 2 commits into
mainfrom
agents

Conversation

@richardcase

Copy link
Copy Markdown
Member

What this PR does / why we need it:

This PR adds two files to the root of the repository.

  • AGENTS.md gives the rules for all contributors and for coding agents. The file has a short description of the project, the make commands, and the rules for commits and pull requests.
  • CLAUDE.md contains only @AGENTS.md. Claude Code reads this line and loads the rules from AGENTS.md. There is one copy of the rules.

The rules for commits are:

  1. All commit messages must obey the Conventional Commits format.
  2. All commits must have a valid signature.
  3. Commit messages and pull request descriptions must not contain agent attribution lines.

Which issue(s) this PR fixes:
None

Special notes for your reviewer:

The commit in this PR obeys the three rules. It has a conventional subject, a GPG signature, and no agent attribution.

Checklist:

  • squashed commits into logical changes
  • includes documentation

@richardcase richardcase added the kind/documentation Documentation only label Oct 26, 2026
@richardcase
richardcase merged commit ca6b113 into main Oct 27, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant