← Files Vibe CodingARCHIVED FILE

docs/MAINTENANCE.md

2.88 KB · Oct 3, 2026 · 06:36 UTC

↓ Download file

# Maintenance

`SKILL.md` defines discovery and routing. Domain recipes live in each skill's `references/`; shared behavior belongs in `references/workflow.md`.

Install validation dependencies with `python3 -m pip install -r requirements.txt`.

1. Find the owning recipe with `python3 scripts/catalog.py search <query>`.
2. Update that recipe and its discovery metadata if the trigger changed.
3. Add or update its `catalog.json` record when its identity, path or operation changes.
4. Run `python3 scripts/catalog.py refresh` and `python3 scripts/validate.py`.
5. Exercise meaningful behavior changes in a disposable repository with explicit expected outcomes.

Keep portable `plugin.json` and `.codex-plugin/plugin.json` metadata synchronized. Increment both versions for a release. Build with `python3 scripts/package.py --output ../vibe-coding.zip`.

Structural checks cover links, hashes, manifests and catalog consistency. They do not establish that every workflow has been executed against each supported external system.

## Catalog and translations

The offline catalog and public website share `assets/catalog/` and `scripts/catalog_site.py`. Add a workflow's title in all four locale JSON files; add category/summary entries for a new skill. Keep placeholders identical across locales. The CLI defaults to English and accepts `search <query> --lang en|es|ru|zh-CN`.

The validator checks the complete generated offline UI as well as recipe bodies, so regenerate it after changing templates, translations, metadata or scripts. Run the repository's `scripts/build_site.py` to refresh the public pages. Do not add another independent catalog template.

Use protocol/framework versions evidenced by the target repository. Recheck the linked official specification when updating version-sensitive MCP, web rendering or authentication guidance.

## Release inventory

`package-files.json` is the explicit approved package inventory, including itself. Review each added path and update this list deliberately. The packager fails before producing a ZIP if a file is unexpected, missing, escaping, symlinked or has a forbidden sensitive name. `.env.example` still needs explicit approval. Never generate the approval list from whatever files happen to exist during packaging.

## Recipe execution contracts

Define the required input and domain invariants before the procedure. An audit includes a finding evidence gate, impact priorities, stop condition and actionable output fields. Implementation includes the authoritative owner, direct consumer change contract, acceptance checks and completion criteria. Verification defines the selected scenario matrix, environment/workload limits, observable evidence and strict passed/failed/blocked verdict. Shared references add domain detail; they do not replace this execution contract.

Use the [recipe execution contract](RECIPE_STANDARD.md) when adding or substantially revising a scenario.

SHA-256: 0da7e18cf88283c7841b4d37c9633b145959d823893d4910358b3d9b868d0cd8