You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
feat: improve catalog submission templates and CODEOWNERS
Simplify the community catalog submission flow to use issue templates
with manual maintainer review (no automation scripts or workflows).
- Add explicit CODEOWNERS entries for catalog.community.json files so
submissions are automatically assigned to a maintainer for review
- Improve preset submission template:
- Add 'Required Extensions' optional field
- Make 'Templates Provided' optional (supports command-only presets)
- Add 'Number of Scripts' optional field
The existing extension and preset issue templates already collect all
required catalog metadata. Maintainers review submissions and manually
update the catalog JSON files.
Closes#2400
Spec Kit uses a dual-catalog system. For details about how catalogs work, see the main [Extensions README](README.md#extension-catalogs).
135
135
136
-
**For extension publishing**: All community extensions should be added to `catalog.community.json`. Users browse this catalog and copy extensions they trust into their own `catalog.json`.
136
+
**For extension publishing**: All community extensions are listed in `extensions/catalog.community.json`. Users browse this catalog and copy extensions they trust into their own `catalog.json`.
To submit your extension to the community catalog, file a new issue using the **[Extension Submission](https://github.com/github/spec-kit/issues/new?template=extension_submission.yml)** template. The template collects all required metadata, including:
148
141
149
-
### 2. Add Extension to Community Catalog
142
+
- Extension ID, name, and version
143
+
- Description, author, and license
144
+
- Repository, download URL, and documentation links
145
+
- Required Spec Kit version and any tool dependencies
146
+
- Number of commands and hooks
147
+
- Tags and key features
148
+
- Testing confirmation
150
149
151
-
Edit `extensions/catalog.community.json` and add your extension:
150
+
> [!IMPORTANT]
151
+
> Do **not** open a pull request directly to edit the catalog JSON. All community extension submissions must go through the issue template so a maintainer can review the metadata and update the catalog.
- Set `downloads: 0` and `stars: 0` (auto-updated later)
204
-
- Use current timestamp for `created_at` and `updated_at`
205
-
- Update the top-level `updated_at` to current time
206
-
207
-
### 3. Update Community Extensions Table
208
-
209
-
Add your extension to the Community Extensions table in the project root `README.md`:
210
-
211
-
```markdown
212
-
| Your Extension Name | Brief description of what it does | `<category>` | <effect> | [repo-name](https://github.com/your-org/spec-kit-your-extension) |
213
-
```
153
+
### What Happens After You Submit
214
154
215
-
**(Table) Category** — pick the one that best fits your extension:
155
+
1. Your issue is automatically labeled and assigned to the Spec Kit maintainers team for review
156
+
2. A maintainer verifies that the metadata is complete and the download URL is accessible
157
+
3. Once approved, the maintainer adds your extension to `extensions/catalog.community.json` and the Community Extensions table in the README
158
+
4. Your extension becomes discoverable via `specify extension search`
216
159
217
-
-`docs` — reads, validates, or generates spec artifacts
218
-
-`code` — reviews, validates, or modifies source code
219
-
-`process` — orchestrates workflow across phases
220
-
-`integration` — syncs with external platforms
221
-
-`visibility` — reports on project health or progress
160
+
### Updating an Existing Extension
222
161
223
-
**Effect** — choose one:
224
-
225
-
- Read-only — produces reports without modifying files
226
-
- Read+Write — modifies files, creates artifacts, or updates specs
227
-
228
-
Insert your extension in alphabetical order in the table.
-[x] Added to Community Extensions table in README.md
277
-
278
-
### Testing
279
-
Tested on:
280
-
- macOS 13.0+ with spec-kit 0.1.0
281
-
- Project: [Your test project]
282
-
283
-
### Additional Notes
284
-
Any additional context or notes for reviewers.
285
-
```
162
+
To update an extension that is already in the catalog (e.g., for a new version), file a new **[Extension Submission](https://github.com/github/spec-kit/issues/new?template=extension_submission.yml)** issue with the updated version, download URL, and any other changed fields. Mention in the issue that this is an update to an existing entry.
0 commit comments