docs: add AGENTS.md + CLAUDE.md agent-contributor guidance#2
Merged
Conversation
Canonical entry point for agents opening PRs against the Familiar Contract spec: branch/PR workflow, spec-change discipline (schemas are normative, keep prose + schema in sync, prefer additive changes, ward semantics are load-bearing/security-sensitive), 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 repository-specific guidance for AI agents contributing to the Familiar Contract spec, establishing AGENTS.md as the canonical workflow/spec-discipline reference and CLAUDE.md as a pointer file for Claude Code.
Changes:
- Add
AGENTS.mddescribing branch/PR workflow, spec-change discipline (schema/prose sync, additive changes), and attribution requirements. - Add
CLAUDE.mdas a thin entrypoint that directs agents toAGENTS.md(andREADME.md) for all contribution guidance.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| CLAUDE.md | Adds a pointer document directing Claude Code (and other agents) to the canonical agent guidance in AGENTS.md. |
| AGENTS.md | Introduces canonical AI-agent contributor guidelines tailored to this spec repo (workflow, schema/prose norms, attribution, safety). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| example/fixture in the repo must validate against its schema: | ||
| ```sh | ||
| # example — use whatever validator the repo scripts provide | ||
| find schemas -name '*.schema.json' -print0 | xargs -0 -n1 <json-schema-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) andCLAUDE.md(thin pointer) so AI agents opening PRs understand this repo's conventions. Tailored to a specification repo: branch/PR workflow, spec-change discipline (schemas underschemas/are normative — keep prose + schema in sync, validate every schema/example, prefer additive changes, and treatwardedits as security-sensitive), 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.