docs: add AGENTS.md + CLAUDE.md agent-contributor guidance#2
Merged
Conversation
Canonical entry point for AI agents opening PRs: the mandatory DCO sign-off (git commit -s), branch/PR workflow, local checks (pnpm run check = validate-skills.sh), skill invariants (narrow/repo-aware, each skill validates), and contributor attribution (GitHub-linked Co-authored-by trailers, never .local emails; both Signed-off-by and Co-authored-by allowed). CLAUDE.md points at AGENTS.md. Signed-off-by: Val Alexander <bunsthedev@gmail.com>
There was a problem hiding this comment.
Pull request overview
Adds agent-focused contributor documentation so AI agents have a single, canonical place to learn this repo’s contribution workflow (DCO sign-off, branching/PR expectations, local validation, and attribution), with CLAUDE.md acting as an entrypoint that points to AGENTS.md.
Changes:
- Add
AGENTS.mdas the canonical agent-contributor guide for this repository. - Add
CLAUDE.mdas a lightweight pointer toAGENTS.mdfor Claude Code auto-loading.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
AGENTS.md |
Introduces agent-specific contribution guidance (workflow, checks, invariants, attribution). |
CLAUDE.md |
Adds a short pointer directing Claude Code users to the canonical AGENTS.md guidance. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| **Read [`AGENTS.md`](AGENTS.md).** It is the canonical guide for AI agents | ||
| (including Claude Code) contributing to this repo — the mandatory **DCO | ||
| sign-off** (`git commit -s`), the branch/PR workflow, local checks | ||
| (`pnpm run check` = `validate-skills.sh`), the skill invariants, and contributor |
| ## Checks — run locally before opening the PR | ||
|
|
||
| ```sh | ||
| pnpm run check # scripts/validate-skills.sh — every skill must validate |
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.
Adds AGENTS.md (canonical agent-contributor guide) and CLAUDE.md (pointer) so agents opening PRs understand this repo's conventions: mandatory DCO sign-off (git commit -s), branch/PR workflow, local checks (pnpm run check = validate-skills.sh), skill invariants (narrow/repo-aware, each skill must validate), and contributor attribution — Co-authored-by: Name ID+username@users.noreply.github.com for real GitHub credit (never a .local email). A commit can carry both Signed-off-by and Co-authored-by.
Part of a fleet-wide rollout across the public Coven repos. Docs-only.
Signed-off-by: Val Alexander bunsthedev@gmail.com