Skip to content

chore: dependency hygiene + contributor onboarding + docs/README truth-up#199

Merged
qnbs merged 1 commit into
mainfrom
chore/hygiene-docs-onboarding
Jun 21, 2026
Merged

chore: dependency hygiene + contributor onboarding + docs/README truth-up#199
qnbs merged 1 commit into
mainfrom
chore/hygiene-docs-onboarding

Conversation

@qnbs

@qnbs qnbs commented Jun 21, 2026

Copy link
Copy Markdown
Owner

User description

Summary

PR F of the Critical & Immediate hardening sequence — cleanup + truth-up ahead of the 1.24.0 release.

Changes

  • README metric drift fixed: scripts/sync-readme-metrics.mjs hard-coded the locale count to 11, so its regexes stopped matching after the 11→17 locale expansion and silently froze the key count at a stale value. Locale count is now dynamic (counts locales/ dirs) and the regexes match any digit count → README reads 2786 keys × 17 locales; drift guard green; re-run is idempotent.
  • joi override: confirmed still required (wait-on@9joi; GHSA-q7cg-457f-vx79); accepted-risk rationale documented in AUDIT.md; pnpm audit --audit-level=high clean.
  • SBOM: evaluated @cyclonedx/cyclonedx-npmdeferred (Socket Security already runs every CI run with an SBOM dashboard); decision recorded in AUDIT.md.
  • Docs truth-up: corrected the stale public/sw.js "must hand-sync APP_VERSION" note in CLAUDE.md (it's auto-synced via predev/prebuild); refreshed stale 5-locale / "2 594 keys × 11 locales" strings in CONTRIBUTING.md + .github/copilot-instructions.md to 17 locales.
  • Onboarding: added a prominent "Do NOT run heavy suites locally" callout + a Minimal Change Checklist to CONTRIBUTING.md, and mirrored the heavy-suite warning into .github/copilot-instructions.md — whose old preflight wrongly told contributors to run test:run + build on every commit, now aligned with the low-end CI-first policy already in AGENTS.md.

Verification

  • check-suppressions (52) · lint · pnpm audit --audit-level=high (clean) · metrics script idempotent + drift-guard green. Docs-only + one build-script change; no app code touched.

🤖 Generated with Claude Code


CodeAnt-AI Description

Refresh README metrics and contributor guidance

What Changed

  • README badges and text now show the current i18n key count and locale count, along with the updated test file count
  • The README sync script now detects locale count automatically, so future locale additions do not leave stale numbers behind
  • Contributor docs now tell people not to run heavy test suites locally, and list the small checks that should be run before pushing
  • Setup notes were updated to reflect that service worker and desktop version numbers are synced automatically, not by hand

Impact

✅ Fewer stale README stats
✅ Clearer contributor setup
✅ Less confusion about release version syncing

💡 Usage Guide

Checking Your Pull Request

Every time you make a pull request, our system automatically looks through it. We check for security issues, mistakes in how you're setting up your infrastructure, and common code problems. We do this to make sure your changes are solid and won't cause any trouble later.

Talking to CodeAnt AI

Got a question or need a hand with something in your pull request? You can easily get in touch with CodeAnt AI right here. Just type the following in a comment on your pull request, and replace "Your question here" with whatever you want to ask:

@codeant-ai ask: Your question here

This lets you have a chat with CodeAnt AI about your pull request, making it easier to understand and improve your code.

Example

@codeant-ai ask: Can you suggest a safer alternative to storing this secret?

Preserve Org Learnings with CodeAnt

You can record team preferences so CodeAnt AI applies them in future reviews. Reply directly to the specific CodeAnt AI suggestion (in the same thread) and replace "Your feedback here" with your input:

@codeant-ai: Your feedback here

This helps CodeAnt AI learn and adapt to your team's coding style and standards.

Example

@codeant-ai: Do not flag unused imports.

Retrigger review

Ask CodeAnt AI to review the PR again, by typing:

@codeant-ai: review

Check Your Repository Health

To analyze the health of your code repository, visit our dashboard at https://app.codeant.ai. This tool helps you identify potential issues and areas for improvement in your codebase, ensuring your repository maintains high standards of code health.

PR F of the 1.24.0 hardening sequence.

- README metric drift: sync-readme-metrics.mjs hard-coded the locale count to 11,
  so its regexes stopped matching after the 11→17 expansion and silently froze the
  key count. Locale count is now dynamic (counts locales/ dirs) and the regexes match
  any digit count → README reads 2786 keys × 17 locales; drift guard green; idempotent.
- joi override: confirmed still required (wait-on@9 → joi; GHSA-q7cg-457f-vx79),
  documented the accepted-risk rationale in AUDIT.md; `pnpm audit --audit-level=high`
  clean. SBOM: evaluated @cyclonedx/cyclonedx-npm, deferred (Socket already runs in CI),
  decision recorded in AUDIT.md.
- Docs truth-up: corrected the stale public/sw.js "must hand-sync APP_VERSION" note in
  CLAUDE.md (auto-synced via predev/prebuild); refreshed stale 5-locale / "2 594 keys ×
  11 locales" strings in CONTRIBUTING.md + .github/copilot-instructions.md to 17 locales.
- Onboarding: added a "Do NOT run heavy suites locally" callout + Minimal Change
  Checklist to CONTRIBUTING.md, and mirrored the heavy-suite warning into
  copilot-instructions.md (whose old preflight wrongly told contributors to run
  test:run + build every commit — now aligned with the low-end CI-first policy).
- AUDIT.md: v1.24.0 hardening-sequence quality-gate line + hygiene-pass section.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@codeant-ai

codeant-ai Bot commented Jun 21, 2026

Copy link
Copy Markdown

Thanks for using CodeAnt! 🎉

We're free for open-source projects. if you're enjoying it, help us grow by sharing.

Share on X ·
Reddit ·
LinkedIn

@vercel

vercel Bot commented Jun 21, 2026

Copy link
Copy Markdown

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

Project Deployment Actions Updated (UTC)
worldscript-studio Ready Ready Preview, Comment Jun 21, 2026 2:09pm

@codeant-ai codeant-ai Bot added the size:M This PR changes 30-99 lines, ignoring generated files label Jun 21, 2026
@qnbs
qnbs merged commit 03ceee9 into main Jun 21, 2026
18 checks passed
@qnbs
qnbs deleted the chore/hygiene-docs-onboarding branch June 21, 2026 14:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size:M This PR changes 30-99 lines, ignoring generated files

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant