docs: lean AGENTS.md to rules, fix the install sentence, and retire comments naming deleted workflows and paths - #418
Merged
Merged
Conversation
Contributor
File size check0 over a hard cap (fails), 32 warning(s).
Split the file, wrap the line, shorten or exempt the comment, or list the path in 5 managed file(s) skipped; repo-platform owns them. |
There was a problem hiding this comment.
Copilot review overview
🟢 Approval recommended
The prose changes accurately match the current code and repository documentation.
Review effort: Balanced
Findings: None
What changed in this PR
This documentation-only PR removes stale guidance and centralizes implementation details in CONTRIBUTING.md.
Changes:
- Streamlines AGENTS.md to durable rules.
- Corrects pre-release npm installation guidance.
- Updates comments describing tests, generators, and file locations.
| File | Description |
|---|---|
| AGENTS.md | Removes duplicated implementation details. |
| README.md | Uses the next npm tag before stable release. |
| src/sections/webhooks/events.ts | Corrects the test path. |
| test/e2e/generators.ts | Clarifies section generation behavior. |
| test/e2e/runner.test.ts | Updates bundle parity rationale. |
| test/e2e/runner.ts | Updates bundle parity documentation. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Vivswan
force-pushed
the
wt/docs-lean
branch
from
September 22, 2026 10:52
cc091dc to
ed77ffe
Compare
Vivswan
force-pushed
the
wt/docs-lean
branch
from
September 22, 2026 11:08
ed77ffe to
60976c7
Compare
Vivswan
force-pushed
the
wt/docs-lean
branch
from
September 22, 2026 11:16
60976c7 to
f0ef88e
Compare
…omments naming deleted workflows and paths - AGENTS.md keeps each rule as one sentence and drops the mechanism CONTRIBUTING.md or the code already carries. - Dropped there: generated output and its drift check, the built lib paths, the e2e command, the COMPAT marker, the test mirror, the registry's checks, and the release topology. - The intro sentence now points at CONTRIBUTING.md for the mechanics. - README.md and docs/reference/library.md no longer say a bare npm install installs the released version; until the first stable release, latest is the 0.0.0 placeholder, so both ask for the next tag as the command line guide does. - The stable-publish verdict's comment in release-pipeline.ts and update-release.yml's say the same: latest names the first publish (placeholder or pre-release) until a release takes it over. - The bundle-parity comments in test/e2e/runner.ts and runner.test.ts no longer name an e2e job that skipped on a package.json-only diff; they say why the pin stays a unit test. - The GenScenarioOptions.sections doc names the --sections flag instead of a smoke or PR-diff subset. - The webhooks events header names test/sections/webhooks/events.test.ts, where the test lives now. - Two auto-fix.yml comments no longer name a dependabot-bun-lockfile.yml workflow that does not exist; the stale-lockfile row says a close/reopen re-runs against the same lockfile and only a push with a real token brings a fresh one.
Vivswan
force-pushed
the
wt/docs-lean
branch
from
September 22, 2026 11:28
f0ef88e to
545e5d7
Compare
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.

Before / After
npm install @vivswan/github-settings-as-code"installs the released version"; npmlatestis the 0.0.0 placeholdernexttag until the first stable release, as docs/start/cli.md already sayslatestrow says it names anextpre-release until the first releaselatestis the 0.0.0 placeholder until the first stable release and ask for@nextuntil thensections: "a smoke or PR-diff subset"--sectionsflag; the default is every registered section"test/sections/webhooks-events.test.tstest/sections/webhooks/events.test.ts, where the test liveslatestnames a pre-release until the first releaselatestnames the first publish (the 0.0.0 placeholder, or a pre-release) until a release takes it over; the verdict itself already handles bothdependabot-bun-lockfile.ymlworkflow that exists nowhereHow
Prose and comments only; no behavior changes.
AGENTS.md is the single source (CLAUDE.md, .github/copilot-instructions.md, .github/agents.md are symlinks) and is edited below the END marker only.
CONTRIBUTING.md is untouched: every dropped clause already lives there, or in the code, once.
Dropped AGENTS.md clauses and where each lives
bun run build:checkfails on driftbun run test:e2eruns the corpusCOMPAT(vN)marker naming the major that deletes it_remove: truedrops a keyed entryThe generated-output sentence in CONTRIBUTING.md line 9 was checked against the table in .github/scripts/generated.ts: both name the settings schema, the upstream-gaps index, and the action.yml and docs regions. Nothing to align.
Proof
bun run typecheck: passbun run lint: passbun run lint:yaml: passbun x actionlint .github/workflows/auto-fix.yml: passbun x typosover the changed files: passbun test test/docs test/architecture test/e2e/runner.test.ts: 497 pass, 0 fail;bun test test/docs test/scripts/release-pipeline.test.tsafter the library and release-comment edits: 482 pass, 0 failbun run build:check: 12 generated files match their generators (README.md carries generated regions; the edit is outside them)Line accounting
Reviewer note
nullis a value, not CSSunset; layering.md owns the rules.BEGIN_COMMIT_OVERRIDE
docs: lean AGENTS.md to rules, fix the install sentence, and retire comments naming deleted workflows and paths
END_COMMIT_OVERRIDE