style: comments carry only what the code cannot show by Vivswan · Pull Request #155 · Vivswan/github-settings-as-code

Vivswan · 2026-09-12T04:44:38Z

The rule

A comment carries only what the code cannot show: the reason a choice was made, an invariant another file relies on, an external system's quirk, a consequence not visible at the line, or the input that motivated a guard. One or two sentences tell it; a block (arrow flow, aligned rows) follows only when it shows the fact faster. Narration of what the code does, its types, its control flow, or its history is deleted, not compressed.

How the sweep ran

Six territories, each swept by hand spot by spot: tests, core (src/ outside the sections), sections, contract, scripts and workflows, e2e harness.
Two independent audits over the swept files; their findings are folded in the last territory commit.
Rebased onto main after refactor(errors): neverthrow Results with typed problems across validation, config, fold, flows, and the library #145 and chore: sync repo-platform build cb69066b5306, adopt the site module, and drop the apply-settings hook #153; the comments those merges added inside swept files got the same pass, so no file lands half swept.

Numbers


Files changed	314
Comment lines in those files	16827 before, 7491 after
Diff	+4603 / -14016

The one non-comment change

The section-contract comments no longer quote Sections-page headings beside their page pointers, so the describe in test/docs/readme.test.ts that checked those quotes ran over an empty set. It is retired with the four constants only it used.

Everything else is verified comment-only: comments were stripped from both sides of every changed file (oxc-parser comment ranges for TypeScript, # lines for YAML) and the remainders compared equal.

Gates

bun run check green.
Fleet file-size check: 0 hard-cap findings, 0 comment findings. The two width warnings on post-green.yml lines 54 and 55 are pre-existing code lines.
Added lines are plain ASCII; no TODO markers.

Copilot

🟡 Changes recommended

GitHub reports merge conflicts with current main, so the branch must be rebased and revalidated.

Get a fresh assessment by requesting another Copilot review.

Pull request overview

This PR removes narrating comments and preserves only non-obvious rationale, invariants, and external constraints across the codebase.

Changes:

Revises comments across runtime code, sections, workflows, scripts, and tests.
Removes a vacuous README contract test and its unused constants.
Leaves runtime behavior unchanged.

File summaries

File	Description
`.github/scripts/arch-lint.ts`	Refines architecture-lint comments.
`.github/scripts/changed-sections.ts`	Refines selector comments.
`.github/scripts/check-endpoint-coverage.ts`	Refines coverage-check comments.
`.github/scripts/coverage-data.ts`	Refines coverage-data comments.
`.github/scripts/fetch-graphql-schema.ts`	Refines schema-fetch comments.
`.github/scripts/file-fuzz-issue.ts`	Refines fuzz-issue comments.
`.github/scripts/gen-action-docs.ts`	Refines action-doc generation comments.
`.github/scripts/gen-docs.ts`	Refines documentation generation comments.
`.github/scripts/gen-gaps-index.ts`	Refines gap-index generation comments.
`.github/scripts/gen-settings-schema.ts`	Refines schema generation comments.
`.github/scripts/graduate-upstream-gaps.ts`	Refines gap-graduation comments.
`.github/scripts/lib/count-word.ts`	Removes narrating API comments.
`.github/scripts/lib/fetch-retry.ts`	Preserves retry rationale concisely.
`.github/scripts/lib/schema-descriptions.ts`	Refines schema-description comments.
`.github/scripts/release-pipeline.ts`	Refines release-pipeline invariants.
`.github/scripts/trim-openapi.ts`	Refines OpenAPI trimming comments.
`.github/workflows/auto-fix.yml`	Streamlines workflow comments.
`.github/workflows/checks.yml`	Streamlines CI comments.
`.github/workflows/post-green.yml`	Streamlines packaging comments.
`.github/workflows/update-release-pr.yml`	Clarifies release-PR anchoring.
`.github/workflows/update-release.yml`	Streamlines release comments.
`architecture.yml`	Condenses architecture guidance.
`lefthook.yml`	Condenses hook rationale.
`src/action/artifact.ts`	Clarifies single-warning behavior.
`src/action/inputs.ts`	Retains input-name quirk.
`src/action/io.ts`	Refines Actions I/O comments.
`src/action/run.ts`	Removes flow narration.
`src/discovery/central.ts`	Retains aggregate-error rationale.
`src/discovery/discover.ts`	Refines discovery comments.
`src/discovery/repos-input.ts`	Clarifies aggregate validation.
`src/discovery/targets.ts`	Refines target-model invariants.
`src/engine/diff.ts`	Refines diff comments.
`src/engine/execute.ts`	Refines execution comments.
`src/engine/layers.ts`	Refines layering comments.
`src/engine/orchestrate.ts`	Refines orchestration comments.
`src/engine/secret-refs.ts`	Refines secret-reference comments.
`src/engine/secrets.ts`	Clarifies secret provenance.
`src/engine/validate.ts`	Refines validation comments.
`src/flows/deliver.ts`	Refines delivery comments.
`src/flows/inputs.ts`	Refines input-contract comments.
`src/flows/layers.ts`	Clarifies layer normalization.
`src/flows/library.ts`	Removes API narration.
`src/flows/merge.ts`	Preserves merge collision rationale.
`src/flows/multi.ts`	Refines multi-run comments.
`src/flows/redact.ts`	Refines redaction invariants.
`src/flows/settings-read.ts`	Clarifies YAML warning suppression.
`src/flows/single.ts`	Clarifies redaction boundary.
`src/flows/summary.ts`	Removes summary narration.
`src/github/api.ts`	Refines client behavior comments.
`src/github/bottleneck-light.d.ts`	Clarifies type shim rationale.
`src/github/paginate.ts`	Condenses pagination rationale.
`src/github/repo-file.ts`	Clarifies absence proof flow.
`src/github/repo-visibility.ts`	Clarifies fail-closed behavior.
`src/github/secret-scan.ts`	Refines secret-scan comments.
`src/index.ts`	Removes export-group labels.
`src/io.ts`	Refines I/O contract comments.
`src/plain-data.ts`	Clarifies tagged-value handling.
`src/report/artifact-report.ts`	Refines encryption rationale.
`src/report/composer.ts`	Removes rendering narration.
`src/report/delivery.ts`	Refines report-delivery comments.
`src/report/issue-report.ts`	Refines issue-report comments.
`src/report/markdown.ts`	Retains escaping-order rationale.
`src/schema.ts`	Refines schema comments.
`src/sections/actions/actions.test.ts`	Streamlines test rationale.
`src/sections/actions/generators.ts`	Preserves fuzz exclusions and seed stability.
`src/sections/actions/index.ts`	Refines section comments.
`src/sections/actions/mock.ts`	Refines mock comments.
`src/sections/actions/schema.ts`	Preserves validation timing rationale.
`src/sections/actions_secrets/actions_secrets.test.ts`	Streamlines family-test comments.
`src/sections/actions_secrets/index.ts`	Removes factory narration.
`src/sections/actions_secrets/mock.ts`	Refines mock-fragment comments.
`src/sections/actions_variables/actions_variables.test.ts`	Streamlines reconciliation tests.
`src/sections/actions_variables/index.ts`	Condenses section documentation.
`src/sections/actions_variables/mock.ts`	Refines mock-fragment comments.
`src/sections/agents_secrets/agents_secrets.test.ts`	Clarifies family-test scope.
`src/sections/agents_secrets/index.ts`	Removes factory narration.
`src/sections/agents_secrets/mock.ts`	Refines mock-fragment comments.
`src/sections/agents_variables/agents_variables.test.ts`	Clarifies family-test scope.
`src/sections/agents_variables/index.ts`	Condenses section documentation.
`src/sections/agents_variables/mock.ts`	Refines mock-fragment comments.
`src/sections/autolinks/generators.ts`	Refines fuzz-generator comments.
`src/sections/autolinks/index.ts`	Condenses section documentation.
`src/sections/autolinks/mock.ts`	Refines mock-fragment comments.
`src/sections/branches/branches.test.ts`	Streamlines branch-test comments.
`src/sections/branches/endpoints.ts`	Refines endpoint comments.
`src/sections/branches/generators.ts`	Refines generator comments.
`src/sections/branches/graphql-rules.ts`	Refines GraphQL-rule comments.
`src/sections/branches/index.ts`	Refines branch-section comments.
`src/sections/branches/mock.ts`	Refines mock comments.
`src/sections/branches/schema.ts`	Preserves canonicalization rationale.
`src/sections/check_suite_preferences/check_suite_preferences.test.ts`	Streamlines write-only tests.
`src/sections/check_suite_preferences/generators.ts`	Refines generator comments.
`src/sections/check_suite_preferences/index.ts`	Clarifies write-only behavior.
`src/sections/check_suite_preferences/mock.ts`	Clarifies PATCH-only state.
`src/sections/check_suite_preferences/schema.ts`	Condenses schema documentation.
`src/sections/code_quality_setup/generators.ts`	Refines generator comments.
`src/sections/code_quality_setup/index.ts`	Removes factory narration.
`src/sections/code_scanning_default_setup/generators.ts`	Preserves enum and seed rationale.
`src/sections/code_scanning_default_setup/index.ts`	Removes factory narration.
`src/sections/codespaces_secrets/codespaces_secrets.test.ts`	Clarifies family-test scope.
`src/sections/codespaces_secrets/index.ts`	Retains permission-grade quirk.
`src/sections/codespaces_secrets/mock.ts`	Refines mock-fragment comments.
`src/sections/collaborators/collaborators.test.ts`	Removes test narration.
`src/sections/collaborators/generators.ts`	Refines invitation-state rationale.
`src/sections/collaborators/index.ts`	Refines section comments.
`src/sections/collaborators/mock.ts`	Preserves invitation semantics.
`src/sections/contract/docs.ts`	Refines documentation-contract comments.
`src/sections/contract/endpoints.ts`	Refines endpoint-contract comments.
`src/sections/contract/errors.ts`	Refines error-contract comments.
`src/sections/contract/graphql.ts`	Refines GraphQL-contract comments.
`src/sections/contract/live.ts`	Clarifies live-response boundary.
`src/sections/contract/module.ts`	Refines module-contract comments.
`src/sections/contract/permissions.ts`	Refines permission comments.
`src/sections/contract/plan.ts`	Refines planning-contract comments.
`src/sections/contract/requests.ts`	Refines request-contract comments.
`src/sections/custom_properties/custom_properties.test.ts`	Streamlines section tests.
`src/sections/custom_properties/generators.ts`	Preserves fixture constraint.
`src/sections/custom_properties/index.ts`	Refines section comments.
`src/sections/custom_properties/mock.ts`	Preserves definition validation rationale.
`src/sections/dependabot_secrets/dependabot_secrets.test.ts`	Clarifies family-test scope.
`src/sections/dependabot_secrets/index.ts`	Removes factory narration.
`src/sections/dependabot_secrets/mock.ts`	Refines mock-fragment comments.
`src/sections/deploy_keys/deploy_keys.test.ts`	Streamlines reconciliation tests.
`src/sections/deploy_keys/generators.ts`	Preserves key-material constraints.
`src/sections/deploy_keys/index.ts`	Clarifies immutable-key handling.
`src/sections/deploy_keys/mock.ts`	Refines storage invariants.
`src/sections/environments/branch-policies.ts`	Refines branch-policy comments.
`src/sections/environments/endpoints.ts`	Refines endpoint comments.
`src/sections/environments/environments.test.ts`	Streamlines section tests.
`src/sections/environments/generators.ts`	Refines generator comments.
`src/sections/environments/index.ts`	Refines section comments.
`src/sections/environments/mock.ts`	Refines mock comments.
`src/sections/environments/nested.ts`	Refines nested-resource comments.
`src/sections/environments/pins.test.ts`	Streamlines pin tests.
`src/sections/environments/pins.ts`	Refines pin invariants.
`src/sections/environments/protection-rules.ts`	Refines protection-rule comments.
`src/sections/environments/schema.ts`	Refines schema rationale.
`src/sections/interaction_limits/generators.ts`	Preserves seed and shape rationale.
`src/sections/interaction_limits/index.ts`	Refines section comments.
`src/sections/interaction_limits/interaction_limits.test.ts`	Streamlines section tests.
`src/sections/interaction_limits/mock.ts`	Refines mock comments.
`src/sections/interaction_limits/schema.ts`	Refines schema comments.
`src/sections/labels/generators.ts`	Refines fuzz-generator comments.
`src/sections/labels/index.ts`	Clarifies normalization brands.
`src/sections/labels/mock.test.ts`	Preserves identity regression context.
`src/sections/labels/mock.ts`	Refines mock-fragment comments.
`src/sections/milestones/generators.ts`	Refines witness comments.
`src/sections/milestones/index.ts`	Condenses section documentation.
`src/sections/milestones/mock.ts`	Refines mock-fragment comments.
`src/sections/pages/generators.ts`	Preserves create-input rationale.
`src/sections/pages/index.ts`	Refines section comments.
`src/sections/pages/mock.test.ts`	Preserves unreachable-contract rationale.
`src/sections/pages/mock.ts`	Clarifies create/update semantics.
`src/sections/pages/pages.test.ts`	Streamlines convergence tests.
`src/sections/pages/schema.ts`	Preserves schema-ID placement rationale.
`src/sections/registry.ts`	Refines registry comments.
`src/sections/repository/generators.ts`	Preserves seed-stability rationale.
`src/sections/repository/index.ts`	Refines section comments.
`src/sections/repository/mock.ts`	Refines mock comments.
`src/sections/repository/repository.test.ts`	Streamlines section tests.
`src/sections/repository/schema.ts`	Clarifies cycle-safe diagnostics.
`src/sections/rulesets/generators.ts`	Refines generator comments.
`src/sections/rulesets/index.ts`	Refines section comments.
`src/sections/rulesets/mock.test.ts`	Preserves visibility-rule rationale.
`src/sections/rulesets/mock.ts`	Clarifies bypass-actor visibility.
`src/sections/rulesets/rulesets.test.ts`	Streamlines section tests.
`src/sections/secret_scanning_custom_patterns/generators.ts`	Refines generator comments.
`src/sections/secret_scanning_custom_patterns/index.ts`	Refines section comments.
`src/sections/secret_scanning_custom_patterns/mock.ts`	Refines mock comments.
`src/sections/secret_scanning_custom_patterns/schema.ts`	Preserves delimiter constraint rationale.
`src/sections/secret_scanning_custom_patterns/secret_scanning_custom_patterns.test.ts`	Streamlines section tests.
`src/sections/shared/list-section.ts`	Refines factory invariants.
`src/sections/shared/repo-secrets.ts`	Refines secret-family comments.
`src/sections/shared/repo-variables.ts`	Refines variable-family comments.
`src/sections/shared/roles.ts`	Clarifies permission vocabularies.
`src/sections/shared/schema-helpers.ts`	Refines schema-helper comments.
`src/sections/shared/secrets-engine.ts`	Refines secret-engine comments.
`src/sections/shared/setup-section.ts`	Refines setup-factory comments.
`src/sections/shared/variables-engine.ts`	Refines variable-engine comments.
`src/sections/teams/generators.ts`	Refines generator comments.
`src/sections/teams/index.ts`	Preserves organization-only behavior.
`src/sections/teams/mock.ts`	Clarifies media-type behavior.
`src/sections/teams/schema.ts`	Removes schema narration.
`src/sections/webhooks/generators.ts`	Preserves normalization rationale.
`src/sections/webhooks/index.ts`	Refines section comments.
`src/sections/webhooks/mock.ts`	Clarifies secret masking and PATCH semantics.
`src/sections/webhooks/schema.ts`	Preserves misplaced-secret guard rationale.
`src/sections/webhooks/webhooks.test.ts`	Streamlines section tests.
`src/sections/workflows/generators.ts`	Refines generator comments.
`src/sections/workflows/index.ts`	Clarifies missing-workflow handling.
`src/sections/workflows/mock.ts`	Refines mock-fragment comments.
`src/sections/workflows/schema.ts`	Removes schema narration.
`src/sections/workflows/workflows.test.ts`	Streamlines workflow tests.
`src/types.ts`	Removes type narration.
`src/upstream-gaps/gap.ts`	Refines upstream-gap comments.
`test/action/action-yml.test.ts`	Streamlines action metadata tests.
`test/action/artifact.test.ts`	Preserves double-warning rationale.
`test/action/inputs.test.ts`	Retains environment-name quirk.
`test/action/io.test.ts`	Streamlines I/O boundary tests.
`test/action/run.test.ts`	Streamlines action-run tests.
`test/architecture/architecture.test.ts`	Streamlines architecture tests.
`test/discovery/central.test.ts`	Preserves deterministic-order rationale.
`test/discovery/discover.test.ts`	Clarifies rate-limit classification.
`test/discovery/targets.test.ts`	Preserves redaction assertions.
`test/docs/biome-schema.test.ts`	Condenses schema-version rationale.
`test/docs/checks-sections-gate.test.ts`	Clarifies selector-token contract.
`test/docs/checks-workflow.test.ts`	Streamlines workflow tests.
`test/docs/ci-workflow.test.ts`	Clarifies all-green exemptions.
`test/docs/claims.ts`	Refines documentation-claim comments.
`test/docs/coverage.test.ts`	Streamlines coverage tests.
`test/docs/diagrams.test.ts`	Streamlines diagram tests.
`test/docs/e2e-nightly-workflow.test.ts`	Clarifies issue-dispatch invariants.
`test/docs/guides.test.ts`	Streamlines guide contract tests.
`test/docs/head-ref.ts`	Clarifies workflow-expression parsing.
`test/docs/markdown.ts`	Retains CommonMark extraction rationale.
`test/docs/permissions.test.ts`	Streamlines permission-doc tests.
`test/docs/post-green-workflow.test.ts`	Refines packaging-gate invariants.
`test/docs/readme.test.ts`	Streamlines comments and removes vacuous heading test.
`test/docs/settings-examples.ts`	Clarifies shared validation purpose.
`test/docs/version-pins.ts`	Refines pin-scanning comments.
`test/e2e/apply-idempotence-proof.test.ts`	Streamlines idempotence proof tests.
`test/e2e/apply-idempotence-proof.ts`	Refines idempotence proof comments.
`test/e2e/apply-idempotence.ts`	Removes declaration narration.
`test/e2e/constants.ts`	Clarifies shared identity invariants.
`test/e2e/foundation.test.ts`	Streamlines foundation tests.
`test/e2e/fuzz.ts`	Refines fuzz-runner comments.
`test/e2e/gen-support.ts`	Refines generator-support comments.
`test/e2e/generators.test.ts`	Streamlines generator tests.
`test/e2e/generators.ts`	Refines generator aggregation comments.
`test/e2e/issue-report-assert.ts`	Refines report assertions.
`test/e2e/mock/chaos.ts`	Refines chaos-injection comments.
`test/e2e/mock/contract.ts`	Refines mock-contract comments.
`test/e2e/mock/core-paths.ts`	Refines core-route comments.
`test/e2e/mock/dispatch.ts`	Refines dispatch comments.
`test/e2e/mock/grading.ts`	Refines permission-grading comments.
`test/e2e/mock/graphql-pipeline.test.ts`	Streamlines GraphQL pipeline tests.
`test/e2e/mock/handler-test-ctx.ts`	Clarifies context construction invariant.
`test/e2e/mock/handlers.ts`	Condenses completeness rationale.
`test/e2e/mock/node-id.ts`	Refines node-ID comments.
`test/e2e/mock/routes.ts`	Refines route comments.
`test/e2e/mock/secrets.test.ts`	Streamlines crypto-state tests.
`test/e2e/mock/secrets.ts`	Preserves synchronous crypto invariants.
`test/e2e/mock/sections.ts`	Refines section aggregation comments.
`test/e2e/mock/server-multi.test.ts`	Streamlines multi-server tests.
`test/e2e/mock/server.test.ts`	Streamlines mock-server tests.
`test/e2e/mock/server.ts`	Refines server comments.
`test/e2e/mock/state.test.ts`	Streamlines mock-state tests.
`test/e2e/mock/state.ts`	Refines mock-state comments.
`test/e2e/mock/support.ts`	Refines shared mock comments.
`test/e2e/openapi/paths.ts`	Refines path-coverage comments.
`test/e2e/openapi/validate.test.ts`	Streamlines response-validation tests.
`test/e2e/openapi/validate.ts`	Refines OpenAPI validation comments.
`test/e2e/oracle.test.ts`	Streamlines oracle tests.
`test/e2e/oracle.ts`	Refines oracle comments.
`test/e2e/prng.ts`	Preserves deterministic-fork rationale.
`test/e2e/run.ts`	Refines scenario-runner comments.
`test/e2e/runner.test.ts`	Streamlines runner tests.
`test/e2e/runner.ts`	Refines runner comments.
`test/e2e/schema.ts`	Refines scenario-schema comments.
`test/engine/check-purity.test.ts`	Streamlines purity tests.
`test/engine/execute.test.ts`	Streamlines execution tests.
`test/engine/layers.test.ts`	Streamlines layering tests.
`test/engine/orchestrate.test.ts`	Streamlines orchestration tests.
`test/engine/secret-refs.test.ts`	Preserves provenance rationale.
`test/engine/secrets.test.ts`	Streamlines secret tests.
`test/engine/validate.test.ts`	Preserves tagged-value rationale.
`test/fixtures/environment-flag-pairing.ts`	Clarifies shared fixture invariant.
`test/flows/multi.test.ts`	Streamlines multi-flow tests.
`test/flows/redact.test.ts`	Removes assertion narration.
`test/flows/settings-read.test.ts`	Clarifies warning-output capture.
`test/github/api.test.ts`	Streamlines API-client tests.
`test/github/graphql.test.ts`	Streamlines GraphQL tests.
`test/github/repo-visibility.test.ts`	Removes fail-closed narration.
`test/github/stub.ts`	Condenses test-stub contracts.
`test/io/mask-pair.test.ts`	Clarifies mask-brand consequence.
`test/library/public-surface.test.ts`	Condenses public-surface rationale.
`test/mock-api.ts`	Clarifies GraphQL mutation recording.
`test/package-pins.test.ts`	Preserves exact-pin incident rationale.
`test/private.test.ts`	Clarifies opener-surface constraints.
`test/published-schema.test.ts`	Streamlines published-schema tests.
`test/report/artifact-report.test.ts`	Preserves byte-search and warning rationale.
`test/report/composer.test.ts`	Preserves Markdown edge-case rationale.
`test/report/delivery.test.ts`	Clarifies fixture validation boundary.
`test/report/issue-report.test.ts`	Streamlines issue-report tests.
`test/schema-corpus.test.ts`	Streamlines schema-corpus tests.
`test/schema-slices.test.ts`	Clarifies object-identity tripwire.
`test/scripts/changed-sections.test.ts`	Streamlines selector tests.
`test/scripts/check-endpoint-coverage.test.ts`	Removes test-suite narration.
`test/scripts/fetch-retry.test.ts`	Retains injected-seam rationale.
`test/scripts/file-fuzz-issue.test.ts`	Streamlines fuzz-issue tests.
`test/scripts/gen-action-docs.test.ts`	Streamlines action-doc tests.
`test/scripts/gen-docs.test.ts`	Streamlines docs-generation tests.
`test/scripts/generated-regions.test.ts`	Streamlines generated-region tests.
`test/scripts/graduate-upstream-gaps.test.ts`	Streamlines gap-graduation tests.
`test/scripts/release-pipeline.test.ts`	Streamlines release-pipeline tests.
`test/scripts/relocated-region.test.ts`	Removes suite narration.
`test/scripts/relocated-region.ts`	Clarifies negative-control purpose.
`test/scripts/schema-descriptions.test.ts`	Removes suite narration.
`test/sections/contract.test.ts`	Streamlines section-contract tests.
`test/sections/docs-registry.test.ts`	Streamlines docs-registry tests.
`test/sections/fragment-fake.ts`	Condenses fake-client rationale.
`test/sections/graphql-contract.test.ts`	Streamlines GraphQL contract tests.
`test/sections/graphql-queries.test.ts`	Streamlines GraphQL query tests.
`test/sections/list-section.test.ts`	Condenses factory-test rationale.
`test/sections/loosen.test.ts`	Preserves Zod-internal tripwire rationale.
`test/sections/plan-idempotence.test.ts`	Streamlines idempotence tests.
`test/sections/plan-idempotence.ts`	Refines idempotence helper comments.
`test/sections/registry.test.ts`	Streamlines registry tests.
`test/sections/roles.test.ts`	Clarifies shared-default consequence.
`test/sections/sealed-box.test.ts`	Preserves fixed-vector provenance.
`test/sections/secret-family.ts`	Condenses shared-family rationale.
`test/sections/secrets-engine.test.ts`	Streamlines crypto and type tests.
`test/sections/section-run.ts`	Condenses test-runner contracts.
`test/sections/setup-section.test.ts`	Streamlines setup-factory tests.

Review details

Files reviewed: 184/314 changed files
Comments generated: 0
Review effort level: Balanced

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Every comment under test/ (except test/e2e) and in the colocated section tests judged against the code-standards comment rules: narration of what the test shows deleted, the one input or bug a guard pins kept, stacks of one-fact sentences reshaped as a two-sentence tell plus rows. Three pre-existing false comments corrected (api rate-limit classification, orchestrate repository section tolerance, the flag-pairing home). No code changed.

Every comment in src/engine, src/flows, src/action, src/github, src/discovery, src/report, and the src root files judged against the code-standards comment rules: narration of what the code does deleted, invariants and quirks kept as a two-sentence tell plus rows, twenty-five false pre-existing claims corrected against the code (among them: not every list endpoint goes through the page loop; the visibility resolver never returns unknown; io.ts is not the only @actions/core importer; the secret scan's Proxy traps do fire). Planning labels removed. No code changed.

…heading tripwire The review of the swept test and core comments found six contradictions and about thirty narrating comments; each is reworded to the invariant the code shows or deleted. The schema.ts header keeps the one Probot-parity fact its README test pins. The section-contract comments no longer quote Sections-page headings beside their page pointers, so the tripwire that checked those quotes over an empty set is retired with the four constants only it used.

…w and sync merges added

github-actions · 2026-09-12T04:57:52Z

File size check

0 over a hard cap (fails), 2 warning(s).

File	Size	Tier	Cap
`.github/workflows/post-green.yml:54`	205 chars	warn	150
`.github/workflows/post-green.yml:55`	193 chars	warn	150

Split the file, wrap the line, shorten or exempt the comment, or list the path in .file-size-allow.local with a # reason.

5 managed file(s) skipped; repo-platform owns them.

Copilot

🟡 Changes recommended

The required commit-names check fails because the current style(contract,tests) commit subject does not use a valid Conventional Commit scope.

Get a fresh assessment by requesting another Copilot review.

Review details

Files reviewed: 184/314 changed files
Comments generated: 0 new
Review effort level: Balanced

…merge

Copilot AI balanced review requested due to automatic review settings September 12, 2026 04:44

Copilot started reviewing on behalf of Vivswan September 12, 2026 04:45

View session

Copilot AI reviewed Sep 12, 2026

View reviewed changes

settings-as-code-release added 9 commits September 12, 2026 00:50

style(sections): comments carry only what the code cannot show

65827f1

style(contract): comments carry only what the code cannot show

84e3c58

style(scripts): comments carry only what the code cannot show

b817616

style(e2e): comments carry only what the code cannot show

9f5e831

style(core): apply the comment standard to the comments the neverthro…

ddb80c7

…w and sync merges added

style(core): drop the blank lines the removed comments left behind

96b8305

Copilot AI review requested due to automatic review settings September 12, 2026 04:57

Vivswan force-pushed the comment-sweep branch from 304f47b to 055ec9b Compare September 12, 2026 04:57

Copilot started reviewing on behalf of Vivswan September 12, 2026 04:57

View session

Copilot AI reviewed Sep 12, 2026

View reviewed changes

style(tests): carry the swept comments through the library packaging …

3bab0b6

…merge

Vivswan force-pushed the comment-sweep branch from 055ec9b to 3bab0b6 Compare September 12, 2026 05:01

Vivswan merged commit 959e226 into main Sep 12, 2026
36 checks passed

Vivswan deleted the comment-sweep branch September 12, 2026 05:05

Navigation Menu

Repository navigation

style: comments carry only what the code cannot show - #155

style: comments carry only what the code cannot show#155
Vivswan merged 10 commits into
mainfrom
comment-sweep

Vivswan commented Sep 12, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

github-actions Bot commented Sep 12, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

Vivswan commented Sep 12, 2026

The rule

How the sweep ran

Numbers

The one non-comment change

Gates

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

🟡 Changes recommended

Uh oh!

github-actions Bot commented Sep 12, 2026

File size check

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

🟡 Changes recommended

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants