docs: add AGENTS.md + CLAUDE.md agent-contributor guidance - #4
Merged
Conversation
Canonical entry point for AI agents opening PRs: branch/PR workflow, local checks (swift package resolve, swift build, swift test --parallel), template-shell invariants (keep it generic, minimal entitlements), and contributor attribution (GitHub-linked Co-authored-by trailers, never .local emails). CLAUDE.md points at AGENTS.md.
There was a problem hiding this comment.
Pull request overview
Adds repository-level contributor guidance for AI agents by introducing a canonical AGENTS.md and a CLAUDE.md shim that points to it. This fits the repo as a reusable SwiftUI macOS shell template by documenting workflow constraints (PR-only, CI-first) and attribution/credit practices without changing runtime code.
Changes:
- Add
AGENTS.mdwith branch/PR workflow, local Swift checks aligned with CI, template invariants, and contributor attribution rules. - Add
CLAUDE.mdas a lightweight entrypoint that directs Claude Code (and other agents) to followAGENTS.md+README.md.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| CLAUDE.md | Points auto-loaded Claude guidance to the canonical AGENTS.md + README.md workflow/conventions. |
| AGENTS.md | Defines agent contributor workflow, CI-aligned local commands, invariants for the template shell, and human attribution requirements. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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 to it) so AI agents opening PRs understand this repo's conventions: branch/PR workflow, local checks, repo invariants, and the contributor-attribution rule — 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.