Skip to content

docs: move agent instructions to AGENTS.md with turborepo agent rules - #44

Merged
amondnet merged 4 commits into
mainfrom
amondnet/turbo-agents.md
Oct 12, 2026
Merged

amondnet merged 4 commits into
mainfrom
amondnet/turbo-agents.md

Conversation

@amondnet

@amondnet amondnet commented Oct 12, 2026 •

Copy link
Copy Markdown
Contributor

Summary

  • Move all agent instructions from CLAUDE.md to a new AGENTS.md. CLAUDE.md now contains only @AGENTS.md.
  • Append the turbo-managed <!-- BEGIN/END:turborepo-agent-rules --> block to AGENTS.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.
  • Add a file-level <!-- eslint-disable markdown/no-multiple-h1 --> comment at the top of AGENTS.md. The turbo block has its own H1, which trips markdown/no-multiple-h1. Editing the block would make turbo rewrite it, so the rule is disabled for the file instead.
  • Add the missing @pleaseai/code-style (packages/cli) row to the Packages table (review feedback).
  • The turbo bump to ^2.11.7 originally in this PR already landed on main in chore(deps)!: update dependencies within semver ranges across workspaces #41, so after merging main this PR no longer changes package.json or bun.lock. Version 2.11 ships docs/ inside the package, which the AGENTS.md block tells agents to read.

Related issue

None.

Checklist

  • PR title follows Conventional Commits
  • Packages build (bun run build)
  • Lint/format pass (bun run lint)
  • Documentation updated if behavior changed
  • No breaking change, or a BREAKING CHANGE: note is included

Verification

  • bun run build and bun run lint pass on turbo 2.11.7 (now the version on main).
  • Running turbo 2.11.7 leaves AGENTS.md unchanged, so the block is recognized.

Summary by cubic

Moves the repository's agent instructions into AGENTS.md and bumps turbo to 2.11.7 so agents can read the bundled Turborepo docs.

  • CLAUDE.md now imports the shared instructions from AGENTS.md.
  • AGENTS.md carries 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.
  • The packages table now includes @pleaseai/code-style (packages/cli).

Written for commit 1301483. Summary will update on new commits.

Turn on auto-fix

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.
@codacy-production

codacy-production Bot commented Oct 12, 2026 •

Copy link
Copy Markdown

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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.

Comment thread AGENTS.md
@amondnet
amondnet marked this pull request as ready for review October 12, 2026 09:25

@cubic-dev-ai cubic-dev-ai Bot left a comment •

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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)
Loading

Reply with feedback, questions, or to request a fix.

Turn on auto-fix | Re-trigger cubic

Comment thread AGENTS.md
@greptile-apps

greptile-apps Bot commented Oct 12, 2026 •

Copy link
Copy Markdown

RetriggerConfidence Score: 5/5

[High impact] The PR appears safe to merge; no blocking issue was found in the documentation move.

Summary

Moves the shared agent instructions into AGENTS.md and makes CLAUDE.md import them.

  • Agents share repository guidance through AGENTS.md.
  • Agents follow version-matched Turborepo guidance before changing its setup.

Reviews (3) · Last reviewed commit: "Merge remote-tracking branch 'origin/mai..." · Reviewed by Greptile

Add the missing @pleaseai/code-style (packages/cli) row to the Packages
table in AGENTS.md.
@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Oct 12, 2026 •

Copy link
Copy Markdown

Deploying code-style with  Cloudflare Pages  Cloudflare Pages

Latest commit: 1301483
Status:🚫  Build failed.

View logs

@amondnet

Copy link
Copy Markdown
Contributor Author

/gemini review

@sonarqubecloud

Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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.

@amondnet amondnet changed the title docs: move agent instructions to AGENTS.md and bump turbo to 2.11.7 docs: move agent instructions to AGENTS.md with turborepo agent rules Oct 12, 2026
@amondnet
amondnet merged commit aa07943 into main Oct 12, 2026
12 of 13 checks passed
@amondnet
amondnet deleted the amondnet/turbo-agents.md branch October 12, 2026 12:15
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.

1 participant