chore: simplify AGENTS.md but keep impact - #334
Open
cameronapak wants to merge 2 commits into
Open
Conversation
Trim the root agent guide to identity, gotchas, a guardrail, and pointers. Move the testing block into docs/testing.md and repoint the package guides at it. Co-authored-by: CommandCodeBot <noreply@commandcode.ai>
🦋 Changeset detectedLatest commit: fbbb760 The changes in this PR will be included in the next version bump. This PR includes changesets to release 0 packagesWhen changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
cameronapak
changed the title
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
Co-authored-by: CommandCodeBot <noreply@commandcode.ai>
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
1 participant
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
Rightsize the root
AGENTS.mdfrom a 108-line kitchen sink down to identity, gotchas, a guardrail, and pointers.Kent posted https://x.com/kentcdodds/status/2087943922073079868 which sparked this in my head to simplify the agents file. https://claude.com/blog/the-new-rules-of-context-engineering-for-claude-5-generation-models
TL;DR - AI models are a LOT better at finding/retrieving context from the repo. Gotchas a more important to cover. More info in https://claude.com/blog/the-new-rules-of-context-engineering-for-claude-5-generation-models
Changes
AGENTS.md(108 → 29 lines): keep identity, gotchas, the one-way dependency guardrail, and router pointers.docs/testing.mdand repoint the three package guides (packages/*/AGENTS.md) at it.Why
Always-on context budget should hold only what every task needs. Release/env/package/testing/domain detail already lives in
PUBLISHING.md,CONTEXT.md, the nested package guides, and the CI configs — the root file should route to them rather than restate them.Test
pnpm lint+prettier --writeran via pre-commit hook (markdown files).Greptile Summary
The PR rightsizes the root agent guide and moves shared testing guidance into a dedicated document.
Confidence Score: 5/5
The documentation-only PR appears safe to merge.
No blocking failure remains.
Important Files Changed
Reviews (2): Last reviewed commit: "chore: restore downstream rebuild gotcha" | Re-trigger Greptile