Skip to content

docs: add AI guidance files (AGENTS.md, CLAUDE.md, Skills)#199

Draft
Rodriguespn wants to merge 3 commits intomainfrom
feature/agents.md
Draft

docs: add AI guidance files (AGENTS.md, CLAUDE.md, Skills)#199
Rodriguespn wants to merge 3 commits intomainfrom
feature/agents.md

Conversation

@Rodriguespn
Copy link
Copy Markdown
Contributor

@Rodriguespn Rodriguespn commented Dec 29, 2025

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:

  • Running pnpm build during development instead of pnpm dev
  • Editing auto-generated files (types.ts, server.json) that should never be modified manually
  • Missing environment variables for tests
  • Inconsistent code patterns

What is the new behavior?

This PR adds a layered system of AI guidance files:

File Type Purpose
CLAUDE.md Entry point that links to AGENTS.md
AGENTS.md Commands, setup, code style, "Do NOT" warnings
Agent Skills On-demand detailed patterns (testing, architecture, tool registration)

Hierarchy:

  1. CLAUDE.md (root + packages) — Links to AGENTS.md

  2. Root AGENTS.md — Repo-wide basics: monorepo structure, build/test commands, package manager, dev dependencies. Points to package-specific guides.

  3. Package AGENTS.md — Package-specific commands, environment variables, code style, "Do NOT" warnings. References Skills for detailed patterns.

  4. 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:

  • AGENTS.md and CLAUDE.md at root and package levels
  • Agent Skills in .claude/skills/ directories

Note 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

@Rodriguespn Rodriguespn self-assigned this Dec 29, 2025
@Rodriguespn Rodriguespn marked this pull request as draft December 30, 2025 10:06
@Rodriguespn Rodriguespn changed the title Feature/agents.md docs: add AI guidance files (AGENTS.md, CLAUDE.md, Skills) Dec 30, 2025
@Rodriguespn Rodriguespn requested review from SaxonF and gregnr December 30, 2025 13:14
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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)

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

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

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