Tighten the repo-state automation so canonical bot commits remain predictable while leaving main clean after each sync. Make the public catalog UI more honest by hiding dev-only sync, turning stars into explicit browser-local saves, aligning risk types, and removing hardcoded catalog counts. Add shared public asset URL helpers, risk suggestion plumbing, safer unpack/sync guards, and CI coverage gates so release and maintainer workflows catch drift earlier.
4.6 KiB
4.6 KiB
Repo coherence and correctness audit
This document summarizes the repository coherence audit performed after the apps/ + tools/ + layered docs/ refactor.
Scope
- Conteggi e numeri (README, package.json, CATALOG)
- Validazione skill (frontmatter, risk, "When to Use", link)
- Audit repo-wide per skill (conformance + baseline usability)
- Riferimenti incrociati (workflows.json, bundles.json,
docs/users/bundles.md) - Documentazione (
docs/contributors/quality-bar.md,docs/contributors/skill-anatomy.md, security/licenses) - Script e build (validate, index, readme, catalog, test)
- Note su data/ e test YAML
Outcomes
1. Conteggi
README.md,package.json, and generated artifacts are aligned to the current collection size.npm run sync:allandnpm run catalogare the canonical commands for keeping counts and generated files synchronized.
2. Validazione skill
npm run validateis the operational contributor gate.npm run validate:strictis currently a diagnostic hardening pass: it still surfaces repository-wide legacy metadata/content gaps across many older skills.- The validator accepts
risk: unknownfor legacy/unclassified skills while still preferring concrete risk values for new skills. - Repo-wide documentation risk guidance is now covered by
npm run security:docs:- detects high-risk command guidance in
SKILL.md, - requires explicit allowlists for deliberate command-delivery patterns,
- and blocks token-like examples that look exploitable.
- detects high-risk command guidance in
2b. Audit repo-wide per skill
- Added
tools/scripts/audit_skills.py(also exposed asnpm run audit:skills), which audits everySKILL.mdand produces a per-skill status (ok,warning,error) with finding codes. - The audit is intentionally broader than
validateand covers:- truncated descriptions that likely map to issue
#365, - missing examples and missing limitations sections,
- overly long
SKILL.mdfiles that should probably be split intoreferences/, - plus the existing structural/safety checks (frontmatter, risk,
When to Use, offensive disclaimer, dangling links).
- truncated descriptions that likely map to issue
- The report also includes a non-blocking
suggested_riskfor skills that are still markedunknownor appear to be misclassified, so maintainers can resolve risk classification during PR review without changing the contributor gate. - Use
npm run audit:skillsfor the maintainer view andnpm run audit:skills -- --json-out ... --markdown-out ...when you want artifacts for triage or cleanup tracking.
3. Riferimenti incrociati
- Added
tools/scripts/validate_references.py(also exposed asnpm run validate:references), which verifies:- ogni
recommendedSkillsin data/workflows.json esiste in skills/; - ogni
relatedBundlesesiste in data/bundles.json; - ogni slug in data/bundles.json (skills list) esiste in skills/;
- every skill link in
docs/users/bundles.mdpoints to an existing skill.
- ogni
- Execution:
npm run validate:references. Result: all references valid.
4. Documentazione
- Canonical contributor docs now live under
docs/contributors/. - Canonical maintainer docs now live under
docs/maintainers/. - README, security docs, licenses, and internal markdown links were rechecked after the refactor.
5. Script e build
npm run testandnpm run app:buildcomplete successfully on the refactored layout.validate_skills_headings.test.jsacts as a lightweight regression/smoke test, not as the source of truth for full metadata compliance.- The maintainer docs now need to stay aligned with the root
package.jsonand the refactoredtools/scripts/*paths.
6. Deliverable
- Counts aligned to the current generated registry.
- Reference validation wired to the refactored paths.
- User and maintainer docs checked for path drift after the layout change.
- Follow-up still open: repository-wide cleanup required to make
validate:strictfully green.
Comandi utili
npm run validate # validazione skill (soft)
npm run validate:strict # hardening / diagnostic pass
npm run audit:skills # audit completo per skill con finding codes e status
npm run validate:references # workflow, bundle, and docs/users/bundles.md references
npm run security:docs # documentation command-risk scan (required for security-sensitive guidance)
npm run build # chain + catalog
npm test # suite test
Issue aperte / follow-up
- Gradual cleanup of legacy skills so
npm run validate:strictcan become a hard CI gate in the future. - Keep translated docs aligned in a separate pass after the canonical English docs are stable.