Skip to content

docs: add AGENTS.md + CLAUDE.md agent-contributor guidance#1

Merged
BunsDev merged 1 commit into
mainfrom
docs/agents-claude-guidance
Jul 6, 2026
Merged

docs: add AGENTS.md + CLAUDE.md agent-contributor guidance#1
BunsDev merged 1 commit into
mainfrom
docs/agents-claude-guidance

Conversation

@BunsDev

@BunsDev BunsDev commented Jul 6, 2026

Copy link
Copy Markdown
Member

Adds AGENTS.md (canonical agent-contributor guide) and CLAUDE.md (thin pointer) so AI agents opening PRs understand this repo's conventions: branch/PR workflow, thin-forwarder invariants (always verify the GitHub X-Hub-Signature-256 webhook signature; no secrets in the repo; app logic lives in coven-github), and contributor attribution — credit humans with Co-authored-by: Name <ID+username@users.noreply.github.com> (never a .local email, 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.

Canonical entry point for agents opening PRs against the hosted webhook
forwarder: branch/PR workflow, thin-forwarder invariants (always verify
the GitHub webhook signature, no secrets in the repo), and contributor
attribution (GitHub-linked Co-authored-by trailer, numeric-id no-reply
form, never a .local email). CLAUDE.md points at AGENTS.md.
Copilot AI review requested due to automatic review settings July 6, 2026 08:32

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds agent-contributor documentation for this repo, establishing AGENTS.md as the canonical guide and CLAUDE.md as a thin pointer so AI agents follow consistent contribution workflow and repo invariants.

Changes:

  • Add AGENTS.md describing branch/PR workflow, repo invariants (thin forwarder; signature verification; no secrets), and contributor attribution trailers.
  • Add CLAUDE.md that redirects Claude Code users to AGENTS.md + README.md.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
AGENTS.md New canonical AI-agent contributor guide covering workflow, invariants, and attribution.
CLAUDE.md New pointer doc directing Claude Code (and others) to follow AGENTS.md.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@BunsDev BunsDev merged commit 4dac51a into main Jul 6, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants