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 (ruff, black --check, pytest), research-reproducibility invariants (seeds/dtype/device determinism), 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 for the OpenFable repo, providing a canonical guide (AGENTS.md) and an auto-loaded pointer for Claude (CLAUDE.md) so AI agents follow the same workflow and quality bars as human contributors.
Changes:
- Add
AGENTS.mdwith agent-specific contribution workflow, local checks, reproducibility invariants, and attribution guidance. - Add
CLAUDE.mdthat directs Claude Code (and other agents) to the canonicalAGENTS.mdguidance.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| CLAUDE.md | Pointer file that directs Claude Code users to the canonical agent contribution guide and existing repo docs. |
| AGENTS.md | Canonical agent-contributor guide covering branching/PR workflow, local checks, reproducibility invariants, attribution, and safety. |
💡 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) and CLAUDE.md (pointer) so agents opening PRs understand this repo's conventions: branch/PR workflow, local checks (ruff, black --check, pytest), research-reproducibility invariants (seeds/dtype/device determinism), 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.