Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions .github/skills/add-community-extension/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,8 @@ Use the existing entries as the format template. Required fields:
"documentation": "<documentation>",
"changelog": "<changelog>",
"license": "<license>",
"category": "<category>",
"effect": "<effect>",
"requires": {
"speckit_version": "<speckit_version>"
},
Expand All @@ -87,6 +89,9 @@ Use the existing entries as the format template. Required fields:
}
```

**Category** — free-form string; common values: `docs`, `code`, `process`, `integration`, `visibility`
**Effect** — one of: `read-only`, `read-write`
Comment thread
mnriem marked this conversation as resolved.

If the extension has optional tool dependencies, add a `"tools"` array inside `"requires"`:

```json
Expand All @@ -113,8 +118,8 @@ Determine the category and effect from the extension's behavior:
| <Name> | <Description> | `<category>` | <Effect> | [<repo-name>](<repository-url>) |
```

**Category** — one of: `docs`, `code`, `process`, `integration`, `visibility`
**Effect** — `Read-only` (produces reports only) or `Read+Write` (modifies project files)
**Category** — free-form; common values: `docs`, `code`, `process`, `integration`, `visibility`
**Effect** — write canonical values `read-only` or `read-write` in `extension.yml` and `catalog.community.json`; use `Read-only`/`Read+Write` only for the docs table display

### 6. Commit, push, and open PR

Expand Down
11 changes: 7 additions & 4 deletions docs/community/extensions.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,21 @@

The following community-contributed extensions are available in [`catalog.community.json`](https://github.com/github/spec-kit/blob/main/extensions/catalog.community.json):

**Categories:**
**Categories** (common values, but any string is allowed):

- `docs` — reads, validates, or generates spec artifacts
- `code` — reviews, validates, or modifies source code
- `process` — orchestrates workflow across phases
- `integration` — syncs with external platforms
- `visibility` — reports on project health or progress

**Effect:**
**Effect** (canonical `extension.yml`/catalog values):

- `Read-only` — produces reports without modifying files
- `Read+Write` — modifies files, creates artifacts, or updates specs
- `read-only` — produces reports without modifying files (displayed as `Read-only` in the table)
- `read-write` — modifies files, creates artifacts, or updates specs (displayed as `Read+Write` in the table)

> [!TIP]
> Extension authors can declare `category` and `effect` in their `extension.yml` under the `extension:` block. These fields are also available in `catalog.community.json` for tooling and the CLI (`specify extension info`).
Comment thread
mnriem marked this conversation as resolved.

| Extension | Purpose | Category | Effect | URL |
|-----------|---------|----------|--------|-----|
Expand Down
Loading
Loading