docs: add AGENTS.md + CLAUDE.md agent-contributor guidance - #2
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 agent-focused contributor documentation so AI agents (and humans) have a single, repo-specific reference for how to work on OpenSesame without violating workflow or template invariants.
Changes:
- Add
AGENTS.mdas the canonical “agent contributor” guide (branch/PR workflow, local checks aligned with CI, template-shell invariants, attribution guidance). - Add
CLAUDE.mdas an entrypoint that redirects Claude Code users toAGENTS.md(andREADME.md).
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| AGENTS.md | New canonical contributor guide for AI agents, including workflow, CI-aligned local checks, invariants, and attribution rules. |
| CLAUDE.md | Lightweight pointer file directing Claude Code (and others) to follow AGENTS.md as the source of truth. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| ## Checks — run locally before opening the PR | ||
|
|
||
| CI (`.github/workflows/ci.yml`) runs the Swift build and tests. Run them first: |
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: branch/PR workflow, local checks (swift build, swift test --parallel), template-shell invariants (keep it generic/reusable, minimal entitlements), and contributor attribution — Co-authored-by: Name ID+username@users.noreply.github.com for real GitHub credit (never a .local email).
Part of a fleet-wide rollout across the public Coven repos. Docs-only.