docs: add AI guidance files (AGENTS.md, CLAUDE.md, Skills)#199
Draft
Rodriguespn wants to merge 3 commits intomainfrom
Draft
docs: add AI guidance files (AGENTS.md, CLAUDE.md, Skills)#199Rodriguespn wants to merge 3 commits intomainfrom
Rodriguespn wants to merge 3 commits intomainfrom
Conversation
mattrossman
reviewed
Dec 30, 2025
Contributor
There was a problem hiding this comment.
These CLAUDE.md can be symlinks to AGENTS.md to save the extra lookup (inspired by the agent setup guide from https://www.effect.solutions/quick-start)
Contributor
Author
There was a problem hiding this comment.
I guess they did the other way around and linked their Agents.md to Claude.md 😆 Good suggestion to use symlinks, it is more straight forward
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.
What kind of change does this PR introduce?
Documentation — Introduces standardized AI guidance files to help AI coding agents work effectively on this codebase.
What is the current behavior?
AI coding agents (Claude Code, Cursor, GitHub Copilot, etc.) have no project-specific context when working on this repository, that could lead to:
pnpm buildduring development instead ofpnpm devtypes.ts,server.json) that should never be modified manuallyWhat is the new behavior?
This PR adds a layered system of AI guidance files:
CLAUDE.mdAGENTS.mdHierarchy:
CLAUDE.md (root + packages) — Links to AGENTS.md
Root AGENTS.md — Repo-wide basics: monorepo structure, build/test commands, package manager, dev dependencies. Points to package-specific guides.
Package AGENTS.md — Package-specific commands, environment variables, code style, "Do NOT" warnings. References Skills for detailed patterns.
Agent Skills (
.claude/skills/) — On-demand loading of detailed architecture, testing patterns, and tool registration guides. Only loaded when triggered by relevant tasks (Agent Skills docs).Files added:
.claude/skills/directoriesNote on Agent Skills
The Agent Skills in this PR are Claude-specific. While an open standard for agent skills has been proposed, it is not yet stable:
Once agent skills are officially adopted as an industry standard, we can adapt these files accordingly. This provides a good starting foundation.
References