Repository navigation
docs: move agent instructions to AGENTS.md with turborepo agent rules - #44
Conversation
Move the CLAUDE.md content into AGENTS.md and import it from CLAUDE.md via @AGENTS.md. Append the turbo-managed agent guidance block so newer turbo versions find it unchanged instead of leaving an uncommitted edit.
2.11 bundles its docs/ in the package, which the turborepo agent rules block in AGENTS.md tells agents to read.
Up to standards ✅🟢 Issues
|
There was a problem hiding this comment.
Code Review
This pull request introduces the AGENTS.md documentation file outlining the monorepo structure, tech stack, and guidelines for @pleaseai/code-style, while replacing the content of CLAUDE.md with a reference to it. Additionally, the turbo dependency is upgraded to version 2.11.7 in both package.json and bun.lock. Feedback on the documentation notes that the @pleaseai/code-style package itself is missing from the Packages table in AGENTS.md and suggests adding it.
There was a problem hiding this comment.
All reported issues were addressed across 4 files
Architecture diagram
sequenceDiagram
participant Agent as AI Agent
participant Repo as Repository
participant CLAUDE as CLAUDE.md
participant AGENTS as AGENTS.md
participant Turbo as Turbo CLI
participant Docs as Turbo Package Docs
participant Lock as bun.lock
Note over Agent,Lock: Runtime Interaction After PR
Agent->>CLAUDE: Read instructions
CLAUDE-->>Agent: @AGENTS.md (reference only)
Agent->>AGENTS: Read full instructions
AGENTS-->>Agent: Repo guidance + turbo rules block
Agent->>Turbo: Run repository-scoped command
Turbo->>Lock: Resolve turbo version
Lock-->>Turbo: 2.11.7
Turbo->>Docs: Read bundled docs/
Docs-->>Turbo: Version-matched guidance
Turbo->>AGENTS: Check existing rule block
alt Block matches template
AGENTS-->>Turbo: Byte-identical - no change
else Block mismatched
Turbo->>AGENTS: Rewrite block with current template
AGENTS-->>Agent: Uncommitted change detected
end
Turbo-->>Agent: Command output
Agent->>AGENTS: Check lint status
AGENTS-->>Agent: Single H1 per file (lint disabled)
Reply with feedback, questions, or to request a fix.
Turn on auto-fix | Re-trigger cubic
|
Add the missing @pleaseai/code-style (packages/cli) row to the Packages table in AGENTS.md.
|
/gemini review |
# Conflicts: # bun.lock # package.json
|
There was a problem hiding this comment.
Code Review
This pull request introduces a new documentation file, AGENTS.md, which details the @pleaseai/code-style monorepo's tech stack, package structure, commands, architecture, and gotchas. It also updates CLAUDE.md to reference this new file. There are no review comments provided, and I have no additional feedback to offer on these documentation changes.



Summary
CLAUDE.mdto a newAGENTS.md.CLAUDE.mdnow contains only@AGENTS.md.<!-- BEGIN/END:turborepo-agent-rules -->block toAGENTS.md. The block is byte-identical to the template turbo 2.11.7 writes, so turbo treats it as unchanged and leaves no uncommitted edit after agent runs.<!-- eslint-disable markdown/no-multiple-h1 -->comment at the top ofAGENTS.md. The turbo block has its own H1, which tripsmarkdown/no-multiple-h1. Editing the block would make turbo rewrite it, so the rule is disabled for the file instead.@pleaseai/code-style(packages/cli) row to the Packages table (review feedback).turbobump to^2.11.7originally in this PR already landed onmainin chore(deps)!: update dependencies within semver ranges across workspaces #41, so after mergingmainthis PR no longer changespackage.jsonorbun.lock. Version 2.11 shipsdocs/inside the package, which theAGENTS.mdblock tells agents to read.Related issue
None.
Checklist
bun run build)bun run lint)BREAKING CHANGE:note is includedVerification
bun run buildandbun run lintpass on turbo 2.11.7 (now the version onmain).AGENTS.mdunchanged, so the block is recognized.Summary by cubic
Moves the repository's agent instructions into
AGENTS.mdand bumpsturboto 2.11.7 so agents can read the bundled Turborepo docs.CLAUDE.mdnow imports the shared instructions fromAGENTS.md.AGENTS.mdcarries the turbo-managed guidance block, byte-identical to the 2.11.7 template so turbo leaves no uncommitted edit, with a file-level lint disable for its extra H1.@pleaseai/code-style(packages/cli).Written for commit 1301483. Summary will update on new commits.