Skip to content

docs: update publishing guide with Category and Effect columns #1912

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
imviancagrace wants to merge 1 commit into from
+14 −1
Closed

docs: update publishing guide with Category and Effect columns #1912

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 14 additions & 1 deletion extensions/EXTENSION-PUBLISHING-GUIDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -209,9 +209,22 @@ Edit `extensions/catalog.community.json` and add your extension:
Add your extension to the Available Extensions table in `extensions/README.md`:

```markdown
| Your Extension Name | Brief description of what it does | [repo-name](https://github.com/your-org/spec-kit-your-extension) |
| Your Extension Name | Brief description of what it does | `category` | Effect | [repo-name](https://github.com/your-org/spec-kit-your-extension) |
Copy link

Copilot AI Mar 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the example table row, category is shown in backticks while the Effect column is the literal word "Effect" (not a placeholder/value). Consider using real placeholder values (e.g., one of the listed categories and either Read-only/Read+Write) and keep formatting consistent with the README table (which uses plain text rather than inline code formatting).

Suggested change
| Your Extension Name | Brief description of what it does | `category` | Effect | [repo-name](https://github.com/your-org/spec-kit-your-extension) |
| Your Extension Name | Brief description of what it does | docs | Read-only | [repo-name](https://github.com/your-org/spec-kit-your-extension) |

Copilot uses AI. Check for mistakes.
```
Comment on lines 209 to 213
Copy link

Copilot AI Mar 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The publishing guide now instructs adding a 5-column row (including Category/Effect), but extensions/README.md currently has a 3-column table (| Extension | Purpose | URL |). As written, this example row won’t match the actual table format; either update extensions/README.md in the same change-set or keep the guide consistent with the existing 3-column README table.

Copilot uses AI. Check for mistakes.

**Category** — pick the one that best fits your extension:

- `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
Comment on lines +215 to +221
Copy link

Copilot AI Mar 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This new Category section can be confused with the later "### Valid Tags" section, which already uses the label "Category" to describe a tag taxonomy (e.g., issue-tracking, vcs, etc.). To avoid ambiguity, consider renaming this table field to something more specific (e.g., "Extension Category") or adding a short note clarifying it’s the README table column, not the tag category list.

Copilot uses AI. Check for mistakes.

**Effect** — choose one:

- `Read-only` — produces reports without modifying files
- `Read+Write` — modifies files, creates artifacts, or updates specs

Insert your extension in alphabetical order in the table.

### 4. Submit Pull Request
Expand Down
Loading