* docs(#2999): document the capability / reviewer-lane / EoS takeover process The capability ecosystem documented a complete forward lifecycle — develop, publish, version, import, update, remove, turn off — but nothing covering a change of maintainer for an entry that already exists. Adds docs/how-to/take-over-a-capability-or-eos.md defining four takeover modes (consensual handoff, adoption fork, first-party absorption, retirement), the PR shape each takes, a per-surface snapshot of the inherited user-visible contract, and an install-continuity checklist. Also corrects .github/PULL_REQUEST_TEMPLATE/registry-entry.md, which directed contributors to a 'Registry' Discussions category that does not exist — the category is named 'EoS Registry' per docs/registries/README.md, and because 'discussion' is a required field the thread must exist before the PR is opened, so the wrong name stalled contributors at the first required step. Closes #2999 Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> * chore(#2999): backfill changeset pr number to 3000 Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> --------- Co-authored-by: sim <sim@local> Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
5.2 KiB
5.2 KiB
Registry Entry PR
Using the wrong template? — Bug fix: use fix.md — New feature (not a registry listing): use feature.md — Enhancement to existing behavior: use enhancement.md
Full schema and process: docs/registries/README.md.
Registry type
- Capability Registry entry — adds/updates one object in
docs/registries/capabilities.json - EoS Registry entry — adds/updates one object in
docs/registries/eos.json - Reviewer Lane Registry entry — adds/updates one object in
docs/registries/reviewers.json
The entry
{
"id": "",
"name": "",
"type": "",
"repo": "",
"description": "",
"author": "",
"license": "",
"enginesGsd": "",
"install": "",
"uninstall": "",
"interactions": {},
"discussion": ""
}
Required-field checklist
id,name,type,repo,description,author,license,enginesGsd,install,uninstall,interactions,discussionare all present and non-empty- (Capability entries only)
interactions.loopExtensionPointsis a non-empty subset of the 12 Loop Extension Points,interactions.hookKinds⊆{step, contribution, gate}, andinteractions.configKeys/requires/runtimeCompat/produces/consumesare present (empty arrays are fine where nothing applies) - (EoS entries only)
protocolVersionis an integer ≥ 1,interactions.interfacePointsis a non-empty subset of the six interface points,interactions.profileis one ofprogrammatic-cli/declarative-cli/ide, andinteractions.axeshas exactly the eight required axis keys plus, optionally,effortSurface(argv/none) - (Reviewer entries only)
interactions.slugmatches the lane slug grammar^[a-z0-9][a-z0-9_-]*$,interactions.flagsis a non-empty array matching^--[a-z0-9][a-z0-9-]*$,interactions.transportisspawnoropenai-http,interactions.evidenceClassissource-groundedordiff-only,interactions.reviewsSectionis a non-empty string (max 200 characters), andinteractions.requiresBinaries/configKeys/runtimeCompatare present (empty arrays are fine where nothing applies)
Ownership & non-endorsement
repolinks to a repository I own or am the primary maintainer of — not a fork, mirror, or someone else's project- I understand that inclusion in this registry means only that a maintainer merged this PR — it is not an endorsement, and GSD has not reviewed, tested, audited, or verified my solution or its claimed GSD interactions
- I understand this entry is removed only for illegal content, malware, spam, or a dead/non-functional link — never for quality — and a maintainer may remove it on that narrow basis without further notice
One entry, one PR
- This PR adds or updates exactly one entry, in exactly one of
capabilities.json/eos.json/reviewers.json - I have not bundled any other registry entry, code change, or unrelated docs change into this PR
Generated file in sync
- I ran
npm run gen:registryafter editing the JSON source, and this PR includes the regenerateddocs/registries/capability-registry.md,docs/registries/eos-registry.md, ordocs/registries/reviewer-registry.md - I did not hand-edit the generated
.mdfile directly — all edits were made to the JSON source
Documentation
CI enforces
lint:docsfor any changeset fragment typedAdded/Changed/Deprecated/Removed— it must also touch a file underdocs/. The JSON source and its regenerated markdown, both underdocs/registries/, satisfy this.
- This PR includes both the JSON source file and the regenerated markdown file under
docs/registries/
Checklist
npm run validate:registrypasses locally against my entrydiscussionlinks to a GitHub Discussion in theEoS Registrycategory — which, despite its name, carries threads for all three registries (or notes that one will be created on merge, per docs/registries/README.md).changeset/fragment added with anAddedtype describing the new listing
Example filled entry
{
"id": "linear-issue-sync",
"name": "Linear Issue Sync",
"type": "capability",
"repo": "some-org/gsd-cap-linear-sync",
"description": "Mirrors ROADMAP.md items to Linear issues as a ship:post contribution.",
"author": "Some Org <hello@some-org.example>",
"license": "MIT",
"enginesGsd": ">=1.6.0",
"install": "gsd capability install https://github.com/some-org/gsd-cap-linear-sync.git#v1.0.0",
"uninstall": "gsd capability remove linear-issue-sync",
"interactions": {
"loopExtensionPoints": ["ship:post"],
"hookKinds": ["contribution"],
"configKeys": ["linear-issue-sync.enabled"],
"requires": [],
"runtimeCompat": ["all"],
"produces": ["linear-issue-links"],
"consumes": ["ROADMAP.md"]
},
"discussion": "https://github.com/open-gsd/gsd-core/discussions/1234"
}