docs: add AGENTS.md + CLAUDE.md agent-contributor guidance - #2
Merged
Conversation
Canonical entry point for agents opening PRs against the Cast plugin: branch/PR workflow, shell-hook safety (POSIX-portable, fail safe, never break the host session), Coven Agent Event Protocol v0 invariants (event shape is a cross-consumer contract), and contributor attribution (GitHub-linked Co-authored-by trailer, never a .local email). CLAUDE.md points at AGENTS.md.
There was a problem hiding this comment.
Pull request overview
Adds agent-focused contributor documentation so AI agents (including Claude Code) follow repo-specific conventions and invariants when opening PRs.
Changes:
- Add
AGENTS.mdas the canonical agent-contributor guide for workflow, protocol invariants, hook safety, and attribution. - Add
CLAUDE.mdas a thin pointer that Claude Code auto-loads, directing agents toAGENTS.md.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| AGENTS.md | Introduces the canonical agent-contributor guidance (workflow, safety, protocol invariants, attribution). |
| CLAUDE.md | Adds a Claude Code entrypoint doc that points contributors to AGENTS.md (and related docs). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+22
to
+24
| - Keep the diff scoped to one concern; conventional-commit subjects (`feat:`, | ||
| `fix:`, `docs:`, `chore:`, `refactor:`). | ||
| - After merge: delete the remote branch, remove your local worktree/branch. |
Comment on lines
+28
to
+29
| - The hooks are **shell scripts** — keep them POSIX-portable, quote variables, | ||
| and fail safe. A hook that errors must not break the host Claude Code session. |
Comment on lines
+8
to
+10
| Claude Code auto-loads this file; everything you need lives in `AGENTS.md` plus | ||
| [`README.md`](README.md). There is no separate Claude-only workflow — follow | ||
| `AGENTS.md`. |
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) andCLAUDE.md(thin pointer) so AI agents opening PRs understand this repo's conventions: branch/PR workflow, shell-hook safety (POSIX-portable, fail safe, never break the host Claude Code session,shellcheck), Coven Agent Event Protocol v0 invariants (event shape is a contract shared by Cast/daemon/TUI/comux), and contributor attribution — credit humans withCo-authored-by: Name <ID+username@users.noreply.github.com>(never a.localemail, which gives zero GitHub credit).Part of a fleet-wide rollout adding consistent AGENTS.md/CLAUDE.md guidance across the public Coven repos. Docs-only.