Repository navigation
docs(agents): slim AGENTS.md to non-derivable context; move guidance into tooling - #598
Merged
Merged
Conversation
Contributor
|
Standing release PR: #595 · v0.41.2 queued (4 packages) · open 4h 52m · ✅ ready to merge Release Preview — v0.41.1 → v0.41.2
These changes will be added to the release PR (#595) when merged: Changelogmonorepo 0.41.1 → 0.41.2
After merge — predicted release
Updated automatically by ReleaseKit |
goosewobbler
force-pushed
the
docs/comment-refs-as-links
branch
from
July 20, 2026 22:45
042f87f to
b8b6781
Compare
…e rule to eslint Rework AGENTS.md around "keep only what an agent can't derive by exploring" (auto-generated / comprehensive context files hurt agent performance): - Cut tech-stack, monorepo tree, verification-gate, coding-standards, testing, and doc-table sections — all derivable from the tree / package.json / configs, or already enforced by tooling. - Keep the load-bearing release invariants, the never-hand-edit generated files, and a pointer to architecture / ADRs. - Move "every it/test title starts with should" into a vitest/valid-title eslint rule and fix the one straggler. This supersedes the comment-ref codification (#573) that was on this branch; the remaining #573 work (ref linkification/removal, custom comment-ref lint) and the other deterministic replacements (pre-push hook, commitlint) move to follow-ups. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01K6CmYRXTZQYs4MNo6AETxT
goosewobbler
force-pushed
the
docs/comment-refs-as-links
branch
from
July 20, 2026 22:49
b8b6781 to
1dd0947
Compare
… prose Replace the "never hand-edit generated files" AGENTS.md section with deterministic guards that fire when someone touches the file, not on every request: - releasekit.schema.json now carries a `$comment` banner (it lacked one; the config docs already had theirs), so it self-documents the moment it's opened. - docs/configuration.md gains a CI check (`docs:check`, mirroring `schema:check`) so a hand-edit fails the build — it previously had only the banner, no enforcement. Both generated files now have banner (discovery) + CI check (enforcement), so the global AGENTS.md instruction is redundant and removed. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01K6CmYRXTZQYs4MNo6AETxT
…lint (#599) The #573 comment convention becomes deterministic instead of prose (see #598): - Custom `local/no-bare-issue-refs` eslint rule flags bare `#NNN` in comments (link as a full URL or drop it). Set to `warn` for now — the ~330 existing source-comment refs are swept in a follow-up, then it flips to `error`. - `vitest/valid-title` gains `mustNotMatch: #\d`, so test titles carry no issue refs; stripped the refs from the ~50 existing titles. - Removed a dead `eslint-disable @typescript-eslint/no-explicit-any` directive (that plugin was never installed) now that eslint lints package sources. Stacked on #598 (builds on its valid-title rule). The source-comment sweep + flip-to-error is the separate #573 PR, which touches packages/*/src. Claude-Session: https://claude.ai/code/session_01K6CmYRXTZQYs4MNo6AETxT Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…600) Complete the #573 comment-ref cleanup and turn on enforcement: - Dropped ~237 bare #NNN provenance citations from packages/*/src comments (all were standalone origin tags; none load-bearing, so none needed URLs). - Flipped local/no-bare-issue-refs from warn to error, scoped to packages/*/src — test comments legitimately reference mock issue/PR data (fixture numbers, external-repo PRs), so they aren't enforced. - Exempted the three ref-parsing files whose #NNN are format examples, not citations: changelogRefs.ts, conventional-changelog.ts, commitParser.ts. - Also dropped ~55 provenance refs from test comments (opportunistic cleanup). All edits are comment-only (verified); eslint/typecheck/biome clean. The only failing tests are pre-existing/environmental integration cases (templates, sync-tags, pipeline fixture) that fail identically on the base. Stacked on #599; touches packages/*/src so it drives a natural standing-PR release. Claude-Session: https://claude.ai/code/session_01K6CmYRXTZQYs4MNo6AETxT Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
The committed smoke workflow had setup-node@v7 (bumped on the generated file) while the source templates it is generated from are at @v6 — so examples:smoke:check failed on every PR. Regenerate to match the source; no template or consumer change. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01K6CmYRXTZQYs4MNo6AETxT
Merged
6 of 19 tasks
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.
Reworks
AGENTS.mdaround the principle that comprehensive / auto-generated context files hurt agent performance — a global instruction is spent on every request even when irrelevant. Keep only what an agent can't derive by exploring; move everything deterministic into tooling that fires exactly when relevant.AGENTS.md: 103 → 16 lines
Kept only the non-derivable core: the six release architecture invariants, one orientation line (standing-PR /
release/next), and a pointer todocs/adr/. Cut tech-stack, monorepo tree, verification gate, coding-standards prose, testing locations, doc tables, and the "read the tree" boilerplate — all derivable or now tooling-enforced.Guidance moved into deterministic tooling
Test-title convention → eslint. "every
it/testtitle starts withshould" is nowvitest/valid-title(mustMatch: ^should) ineslint.config.js(+ fixed the one straggler)."Never hand-edit generated files" → banner + CI check. Each generated file now has both layers, so the AGENTS.md prose is redundant and removed:
releasekit.schema.jsongains a$commentbanner (it lacked one — the config docs already had theirs), self-documenting on open.docs/configuration.mdgains a CI check (docs:check, mirroringschema:check), so a hand-edit fails the build — it previously had only a banner, no enforcement.Discovery (banner) catches it in-context; the CI check is the deterministic backstop that fires regardless of whether any agent read anything.
Relationship to #573
Supersedes the comment-ref codification that was on this branch (we're removing prose, not adding it). Remaining #573 work (bare-
#NNNcleanup + a custom comment-ref lint rule) and the other replacements (pre-push hook, commitlint) are follow-ups.Validation
schema:checkanddocs:checkboth green.docs/configuration.mdnow failsdocs:check.🤖 Generated with Claude Code
Greptile Summary
This PR moves repository guidance into focused lint and CI enforcement. The main changes are:
AGENTS.mdto release architecture invariants.Confidence Score: 5/5
This looks safe to merge.
Important Files Changed
Reviews (6): Last reviewed commit: "chore(ci): regenerate examples-smoke.yml..." | Re-trigger Greptile