chore: release/repo hygiene, doc truth-up + drift gate, gate governance by qnbs · Pull Request #280 · qnbs/WorldScript-Studio

qnbs · 2026-07-28T20:16:14Z

Summary

Stacked on #279 (OpenRouter). Three related hygiene workstreams:

WS-5 — Release & repo hygiene

Removed a duplicate codecov badge and the CII Best Practices badge (literal projects/XXXX placeholder — broken image, dead link); added a TODO.md entry with the registration URL (external signup, maintainer action).
Added .github/CODE_OF_CONDUCT.md (Contributor Covenant 2.1); fixed .github/CONTRIBUTING.md's external CoC link to point at it; added a missing CoC section to the root CONTRIBUTING.md (the one README.md actually links to).
Investigated (no code changes): the v1.5.0 GitHub release's 6 assets are all named StoryCraft.Studio_1.20.0_... — the pre-rebrand product name with a mismatched version, published far out of chronological order. Flagged for maintainer decision (see final report). Issue chore(security): upstream y-webrtc diff check — vendor fork audit #60 already has a maintainer comment confirming the audit is done; no action taken, it's correctly staying open per its own "permanent reminder" note.

WS-6 — Doc truth-up + drift gate

Fixed stale "17 locales" claims (post 17→19 expansion) across ROADMAP.md (also still marked v1.24 "PLANNED" despite both v1.24.0 and v1.24.1 having shipped), docs/TRANSLATION-GUIDE.md (also missing desktop.json from its module list), root CONTRIBUTING.md, .github/copilot-instructions.md, and docs/i18n/AUDIT_AND_IMPROVEMENT_PLAN.md. Left every CHANGELOG.md/dated AUDIT.md/TODO.md historical entry untouched.
Added scripts/check-doc-metrics.mjs (pnpm run docs:check, wired into CI) — computes actual locale/key counts and the latest release tag, then fails if a target doc states a different number or an already-released version is still marked "PLANNED". Historical sections are exempt via a heuristic covering this repo's several "done" conventions; the exemption logic has its own test file per the plan's explicit requirement.

WS-7 — Gate governance

Re-pinned token-audit-baseline.json to the actual measured value (160, down from a stale 165) — ratchets down only.
Added scripts/check-coverage-ratchet.mjs (non-blocking, continue-on-error: true in CI) — suggests raising a coverage threshold when the measured value has 2+ points of headroom, mechanizing a rule that existed only as a comment in vitest.config.ts. Added the json-summary reporter so coverage-summary.json actually gets produced.
docs/CODE_QUALITY.md: added a Suppression Reduction Plan grouping all 33 noExplicitAny suppressions by cluster/effort (visibility only, no code changes).
docs/CI.md: corrected 3 places still describing Stryker as part of the active ci.yml pipeline — it was removed 2026-06-02 and runs only via manual workflow_dispatch.

Test plan

pnpm run lint / typecheck — clean
pnpm run docs:check — new gate passes; verified it catches injected drift (tested against a corrupted README, then reverted)
pnpm run token:audit — 160 ≤ 160 (re-pinned baseline)
pnpm run i18n:check / parity:check — unaffected, still green
tests/unit/checkDocMetrics.test.ts — 10 tests covering the historical-exclusion heuristic
pnpm run build && pnpm run bundle:budget — green
CI (pending)

🤖 Generated with Claude Code

vercel · 2026-07-28T20:16:20Z

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
worldscript-studio	Ready	Preview, Comment	Jul 28, 2026 10:06pm

coderabbitai · 2026-07-28T20:16:22Z

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 2bd2c72f-7f1f-4b03-959d-1b192ce7725a

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

✅ Review completed - (🔄 Check again to review again)

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch chore/release-doc-gates

_{Comment @coderabbitai help to get the list of available commands.}

codeant-ai · 2026-07-28T21:23:54Z

🏁 CodeAnt Quality Gate Results

Commit: 9425d0ef
Scan Time: 2026-07-28 21:23:53 UTC

✅ Overall Status: PASSED

Quality Gate Details

Quality Gate	Status	Details
Secrets	✅ PASSED	0 secrets found
Duplicate Code	✅ PASSED	0.0% duplicated
SAST	✅ PASSED	No security issues
Bugs	✅ PASSED	Rating S: No bugs
IAC	✅ PASSED	Rating S: No issues

View Full Results

…h CONTRIBUTING files - README.md: removed the duplicate codecov badge (kept the more informative `&label=Coverage` one) and the CII Best Practices badge, which had a literal `projects/XXXX` placeholder (broken image, dead link) — the project was never registered. Added a TODO.md entry with the registration URL; that's an external, interactive signup, so it stays a maintainer action, not something this pass does automatically. - Added .github/CODE_OF_CONDUCT.md (Contributor Covenant 2.1), with an enforcement-contact section that mirrors SECURITY.md's pattern (GitHub Private Vulnerability Reporting, no hardcoded personal email). - .github/CONTRIBUTING.md already referenced a Code of Conduct but linked externally to contributor-covenant.org instead of the new in-repo file — repointed it. - The root CONTRIBUTING.md — the one README.md actually links to — had no Code of Conduct section at all. Added one, linking to the new file. Investigated (no code changes, per the workstream's stop-and-ask boundaries): - The v1.5.0 GitHub release sits chronologically between v1.20.0 and v1.21.0 despite its lower semver, AND its 6 assets are all named "StoryCraft.Studio_1.20.0_..." — the project's pre-rebrand name (rebrand to WorldScript Studio shipped in v1.23.0) with a version that doesn't match the release tag at all. Flagged for the final report; deleting/retitling a public release is a maintainer decision. - Issue #60 (vendor-fork audit, "permanent reminder — do not close") already has a 2026-07-28 maintainer comment documenting the audit as done, and `pnpm run verify:vendor` passes all 12 invariants. No action needed — it's correctly staying open per its own instruction.

… drift gate ROADMAP.md still marked v1.24 as "(PLANNED)" though v1.24.0 (2026-06-21) and v1.24.1 (2026-07-28) had both already shipped, and gave the locale count as 17 — stale since the 11->17 expansion (v1.24.0) plus ru/ko (landed the next day, before v1.24.1). Same "17 locales" drift was independently present in docs/TRANSLATION-GUIDE.md (also missing 1 of 21 modules — desktop.json — from its module list and count), the root CONTRIBUTING.md (the one README.md actually links to), .github/copilot-instructions.md (2 occurrences), and docs/i18n/AUDIT_AND_IMPROVEMENT_PLAN.md's "current state" section. Fixed all of them; left every CHANGELOG.md and dated AUDIT.md/TODO.md historical entry untouched — they correctly describe what was true at a past release. Added scripts/check-doc-metrics.mjs (wired into ci.yml's quality job as `pnpm run docs:check`) so this class of drift fails CI instead of silently accumulating again. It computes the actual locale count, key count (dedup'd the same way check-i18n-keys.mjs does), and latest released version tag, then scans README/ROADMAP/TODO/TRANSLATION-GUIDE/CONTRIBUTING for stale numbers or a "vX.Y.Z ... PLANNED" claim for an already-released version. Historical sections are exempt (Keep-a-Changelog `## [x.y.z]`, `## vX.Y.Z ... RELEASED ...`, a heading suffixed with an emoji checkmark, a `**Status:** ✅ Released/Completed` line just below a heading, or this repo's own TODO.md "✅ = done" bullet convention) — the first version only recognized the Keep-a-Changelog/RELEASED-heading shapes and produced 26 false positives against TODO.md/ROADMAP.md's other historical conventions; broadened it before wiring the gate in. tests/unit/checkDocMetrics.test.ts covers the exclusion heuristic directly (the plan's explicit requirement — an untested exclusion rule turns a drift gate into noise).

…n, mutation-testing status - Re-pinned token-audit-baseline.json to the actual measured total (160, down from a stale 165 dated 2026-06-14) after WS-1..6 landed. Ratchets down only, per the project's hard rule against loosening a quality gate. - Added scripts/check-coverage-ratchet.mjs: reads coverage/coverage-summary.json (added the `json-summary` reporter to vitest.config.ts — it wasn't being generated at all) and suggests raising a threshold when the measured value sits 2+ points above it, matching the "3 green runs, max 5 pts/quarter" rule already documented as a comment in vitest.config.ts but never mechanized. Wired into ci.yml as `continue-on-error: true` — informational only, never blocks the build; the ratchet decision stays with the maintainer. - docs/CODE_QUALITY.md: added a Suppression Reduction Plan grouping all 33 noExplicitAny suppressions (of 52 total, at an exact-match baseline with no headroom) into clusters by root cause and effort — no code changes, visibility only. - docs/CI.md: corrected three places that still described Stryker mutation testing as part of the active `ci.yml` job graph (job-graph diagram, the `mutation` job's table row, and the CI-tier table) — it was removed from the merge pipeline on 2026-06-02 and now runs only via manual `workflow_dispatch` on mutation.yml. Documented why, how to trigger it, and the re-integration criterion.

qnbs · 2026-07-28T23:14:18Z

This PR was auto-closed by GitHub when PR #279 merged (its base, fix/openrouter-live-catalog, was a force-pushed/rebased branch during PR #279's own CodeRabbit correction loop; GitHub couldn't cleanly retarget this PR to main and closed it instead of auto-retargeting). The branch and all its commits are intact — recreated as #283, now targeting main directly.

qnbs mentioned this pull request Jul 28, 2026

chore: WS-8 follow-ups — parity audit fix, README caveat, Dependabot auto-merge, locale key dedup #281

Merged

8 tasks

qnbs force-pushed the fix/openrouter-live-catalog branch from 9425d0e to 645d3f6 Compare July 28, 2026 21:23

qnbs force-pushed the fix/openrouter-live-catalog branch from 645d3f6 to 27016cf Compare July 28, 2026 21:26

qnbs force-pushed the chore/release-doc-gates branch from 96a888c to 9c1bebb Compare July 28, 2026 21:37

qnbs added 3 commits July 29, 2026 00:05

qnbs force-pushed the chore/release-doc-gates branch from 9c1bebb to aadad0e Compare July 28, 2026 22:05

qnbs deleted the branch fix/openrouter-live-catalog July 28, 2026 23:10

qnbs closed this Jul 28, 2026

qnbs mentioned this pull request Jul 28, 2026

chore: release/repo hygiene, doc truth-up + drift gate, gate governance #283

Merged

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: release/repo hygiene, doc truth-up + drift gate, gate governance - #280

chore: release/repo hygiene, doc truth-up + drift gate, gate governance#280
qnbs wants to merge 3 commits into
fix/openrouter-live-catalogfrom
chore/release-doc-gates

qnbs commented Jul 28, 2026

Uh oh!

vercel Bot commented Jul 28, 2026 •

edited

Loading

Uh oh!

coderabbitai Bot commented Jul 28, 2026 •

edited

Loading

Review skipped

Uh oh!

codeant-ai Bot commented Jul 28, 2026

Uh oh!

qnbs commented Jul 28, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Conversation

qnbs commented Jul 28, 2026

Summary

Test plan

Uh oh!

vercel Bot commented Jul 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai Bot commented Jul 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review skipped

Uh oh!

codeant-ai Bot commented Jul 28, 2026

🏁 CodeAnt Quality Gate Results

✅ Overall Status: PASSED

Quality Gate Details

Uh oh!

qnbs commented Jul 28, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

vercel Bot commented Jul 28, 2026 •

edited

Loading

coderabbitai Bot commented Jul 28, 2026 •

edited

Loading