docs: add AGENTS.md + CLAUDE.md agent-contributor guidance#6
Merged
Conversation
Canonical entry point for AI agents opening PRs: the mandatory DCO sign-off (git commit -s), the master default branch, branch/PR workflow, local checks (npm test), deterministic/local-first invariants, and contributor attribution (GitHub-linked Co-authored-by trailers, never .local emails; a commit can carry both Signed-off-by and Co-authored-by). 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 to make it easier for AI agents (and tooling that auto-loads agent instructions) to follow this repo’s contribution requirements and workflow expectations.
Changes:
- Add
AGENTS.mdas the canonical AI-agent contributor guide (DCO sign-off, branch workflow, local checks, determinism/local-first expectations, attribution guidance). - Add
CLAUDE.mdas a lightweight pointer toAGENTS.mdfor Claude Code’s auto-loaded instructions.
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, including DCO, workflow, checks, invariants, and attribution rules. |
CLAUDE.md |
Points Claude Code users to AGENTS.md (and existing repo docs) as the single source of truth. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| CI (`.github/workflows/test.yml`) runs the Node test suite. Run it first: | ||
|
|
||
| ```sh | ||
| npm test # node --test across the test/ suite |
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), master default branch, local checks (npm test), deterministic/local-first invariants, 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