docs: add AGENTS.md + CLAUDE.md agent-contributor guidance#32
Merged
Conversation
Canonical entry point for AI agents opening PRs against the GitHub App adapter: the mandatory DCO sign-off (git commit -s), branch/PR workflow, local CI gates (cargo check/clippy -D warnings/test), adapter invariants (no App secrets, GitHub-native progress surfaces), and contributor attribution. Notes that a commit can carry both Signed-off-by and Co-authored-by trailers. CLAUDE.md points at AGENTS.md. Signed-off-by: Val Alexander <bunsthedev@gmail.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Adds agent-focused contributor documentation so automated contributors (Claude Code, Codex, etc.) follow this repo’s contribution workflow and constraints, while keeping AGENTS.md as the single source of truth and CLAUDE.md as an auto-loaded pointer.
Changes:
- Add
AGENTS.mdwith agent-specific contribution workflow, local CI gates, repo invariants, and attribution guidance. - Add
CLAUDE.mdas a thin pointer directing Claude Code users toAGENTS.md.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
AGENTS.md |
Introduces canonical AI-agent contribution guidance (DCO, workflow, CI gates, invariants, attribution). |
CLAUDE.md |
Provides a lightweight entrypoint that redirects agents to AGENTS.md plus existing repo docs. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Signed-off-by: Val Alexander <bunsthedev@gmail.com>
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
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.
What & why
Adds
AGENTS.md(canonical agent-contributor guide) andCLAUDE.md(thin pointer) so AI agents — Codex, Claude Code, Hermes, Coven familiars — opening PRs understand this repo's conventions.Tailored to coven-github:
git commit -son every commit (this PR is signed off).cargo check --all-targets,cargo clippy --all-targets -- -D warnings,cargo test --all.Co-authored-by: Name <ID+username@users.noreply.github.com>for real GitHub credit (never a.localemail); a commit can carry bothSigned-off-byandCo-authored-by.Part of a fleet-wide rollout across the public Coven repos. Docs-only.
Signed-off-by: Val Alexander bunsthedev@gmail.com