Skip to content

Latest commit

 

History

History
74 lines (48 loc) · 6.76 KB

File metadata and controls

74 lines (48 loc) · 6.76 KB

First-Party Maintenance and Documentation Synchronization

中文维护说明

This document governs the lifecycle of admitted first-party Skills and the documentation that makes them maintainable and installable. It does not duplicate the ownership contract (AGENTS.md) or the architecture.

Authoritative records

Keep each fact in one authoritative location and link elsewhere:

Fact Authoritative location
Package behavior, triggers, invocation, inputs, outputs, resources skills/<skill-name>/SKILL.md (and its supporting files)
Provenance for a Port/transformed package skills/<skill-name>/ATTRIBUTION.md
Human-readable inventory CATALOG.md, synchronized from package metadata
Installation procedure and proof requirements docs/INSTALLATION.md
Review triggers, reviewer vs engine vs acceptance docs/REVIEW_POLICY.md · docs/REVIEWER_CONTRACT.md
Repository change history CHANGELOG.md and the actual release record
Composition validation assets docs/workflows/ and linked evidence

Current synchronization baseline

The admitted collection contains 34 first-party Skills under skills/ (see CATALOG.md). Current stable release is v0.2.0, whose line now carries all 34 first-party packages — 33 at the original publication plus the humanizer admission (see CHANGELOG.md); previous stable was v0.1.6 (9 packages).

History markers: v0.1.1 (five), v0.1.2 (seven), v0.1.3 toolchain migration, v0.1.4 (kanban-worker as light-kanban-worker), v0.1.5 scheduling + identity hardening, v0.1.6 (kb-init). Structural/discovery checks live in tests/test_collection_discovery.py and tests/test_composition.py; they are structural evidence, not fresh-install proof.

Change workflow

For every add / update / rename / deprecation / removal / port / adapt:

  1. Re-check ownership and reuse-before-invention in Skill admission — approved Matt PORTs (SPEC §14) are architecture-authorized when they carry ATTRIBUTION.md and no runtime dependency.
  2. Preserve package boundary, invocation direction, and required attribution.
  3. Classify as eligible low-risk prompt-only fast track or full path; collect only the evidence that route requires.
  4. Apply the review trigger in review policyreview-loop is the engine, project-review owns final acceptance.
  5. Synchronize README, catalog, installation guide, governance links, affected composition examples, discovery/composition tests, attribution records, and changelog together.
  6. Prepare an unreleased changelog entry. Do not claim a version, tag, or verified release command until the release gate passes.

Synchronization matrix

Change Documentation and validation that must be reviewed
Add README, catalog, installation guide, governance references, affected composition examples (docs/workflows/), discovery + composition tests, changelog, applicable ATTRIBUTION.md, fresh-install evidence, and the selected fast-track or full-path verdict.
Update Package contract and behavior evidence; affected catalog, installation, attribution, examples, discovery/composition tests, compatibility evidence, and changelog.
Rename Old-to-new migration guidance; all links, catalog records, installer examples, discovery/composition tests, examples, attribution references, and changelog.
Deprecate Catalog status, README guidance, replacement/migration path, installation warning, examples, discovery/composition tests, changelog, and release notes.
Remove Confirm no supported consumer needs a shim; remove stale references, preserve migration guidance, update catalog/installation, and record the removal.
Port Upstream source read, ATTRIBUTION.md (source/path/revision/license/Light changes), Light handoff adaptation, no upstream runtime dependency, plus Add-matrix docs/tests.
Adapt Reference upstream pattern, describe Light-specific integration need, preserve ATTRIBUTION.md where applicable, plus Update-matrix docs/tests.

Catalog and installation maintenance

Catalog entries must name purpose, when to use (where useful), invocation type, package path, status, installation scope, and evidence. Package metadata (SKILL.md frontmatter + agents/openai.yaml) remains the source of truth; do not create a second static routing table.

Every release installation example must name an actual released source and match the current catalog. Verify whole-repository and per-Skill installation against a fresh environment, then preserve exact command, released revision, host, and observed discovery result in the release evidence. Until that exists, keep commands marked as templates.

Upstream attribution and compatibility

Approved Matt PORTs are self-contained first-party packages with ATTRIBUTION.md (source repo, original path, revision/tag, license/notice, Light-specific changes) and no required runtime install of mattpocock/skills. Other upstream sources may be recommended for direct use without being copied. A package that remains principally a third-party modification belongs in skills-3rdParty.

Before release, review attribution, licenses/notices, dependency availability, supported hosts, installation behavior, and known behavioral differences. Light main workflow must not require mattpocock/skills or sol-advisor at runtime.

Composition examples

Documents in docs/workflows/ are validation assets. They explain Skill composition and handoff (entry → handoff → stop → optional), not internal Skill workflows. They cannot become hidden admission prerequisites or an automatic workflow.

Deprecation, rollback, and release

Deprecation is explicit: mark catalog and installation guidance, name a replacement or state none, retain migration info for the released support period, and record in the changelog.

If a release candidate fails verification, stop promotion and repair through the applicable review process. Do not rewrite published history or erase evidence. A stable release requires only admitted packages, synchronized docs, verified installation commands, required review evidence, and a real version/tag.

Closeout record

At closeout, record final repository location, released versions/tags, verified commands, first-party catalog (34), approved Ports vs direct upstream vs modified third-party distinctions, evidence, limitations, and migration/archive guidance. Do not label structural or simulated evidence as runtime proof. Historical evidence (docs/evidence/) stays immutable.