From ebc61067e8d9913ec2a0b37d8b6c032b7c4c511b Mon Sep 17 00:00:00 2001 From: Manfred Riem <15701806+mnriem@users.noreply.github.com> Date: Tue, 24 Mar 2026 12:34:32 -0500 Subject: [PATCH] docs: move community extensions table to main README for discoverability (#1959) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Add ๐Ÿงฉ Community Extensions section to README.md before Community Walkthroughs - Add table of contents entry for the new section - Replace extensions/README.md table with a link back to the main README - Update EXTENSION-PUBLISHING-GUIDE.md references to point to README.md - Update EXTENSION-DEVELOPMENT-GUIDE.md references to point to README.md --- README.md | 39 ++++++++++++++++++++++- extensions/EXTENSION-DEVELOPMENT-GUIDE.md | 2 +- extensions/EXTENSION-PUBLISHING-GUIDE.md | 8 ++--- extensions/README.md | 32 ++----------------- 4 files changed, 45 insertions(+), 36 deletions(-) diff --git a/README.md b/README.md index 36a6dfa4d..a407d43e9 100644 --- a/README.md +++ b/README.md @@ -22,6 +22,7 @@ - [๐Ÿค” What is Spec-Driven Development?](#-what-is-spec-driven-development) - [โšก Get Started](#-get-started) - [๐Ÿ“ฝ๏ธ Video Overview](#๏ธ-video-overview) +- [๐Ÿงฉ Community Extensions](#-community-extensions) - [๐Ÿšถ Community Walkthroughs](#-community-walkthroughs) - [๐Ÿ› ๏ธ Community Friends](#๏ธ-community-friends) - [๐Ÿค– Supported AI Agents](#-supported-ai-agents) @@ -156,6 +157,42 @@ Want to see Spec Kit in action? Watch our [video overview](https://www.youtube.c [![Spec Kit video header](/media/spec-kit-video-header.jpg)](https://www.youtube.com/watch?v=a9eR1xsfvHg&pp=0gcJCckJAYcqIYzv) +## ๐Ÿงฉ Community Extensions + +The following community-contributed extensions are available in [`catalog.community.json`](extensions/catalog.community.json): + +**Categories:** `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:** `Read-only` โ€” produces reports without modifying files ยท `Read+Write` โ€” modifies files, creates artifacts, or updates specs + +| Extension | Purpose | Category | Effect | URL | +|-----------|---------|----------|--------|-----| +| Archive Extension | Archive merged features into main project memory. | `docs` | Read+Write | [spec-kit-archive](https://github.com/stn1slv/spec-kit-archive) | +| Azure DevOps Integration | Sync user stories and tasks to Azure DevOps work items using OAuth authentication | `integration` | Read+Write | [spec-kit-azure-devops](https://github.com/pragya247/spec-kit-azure-devops) | +| Checkpoint Extension | Commit the changes made during the middle of the implementation, so you don't end up with just one very large commit at the end | `code` | Read+Write | [spec-kit-checkpoint](https://github.com/aaronrsun/spec-kit-checkpoint) | +| Cleanup Extension | Post-implementation quality gate that reviews changes, fixes small issues (scout rule), creates tasks for medium issues, and generates analysis for large issues | `code` | Read+Write | [spec-kit-cleanup](https://github.com/dsrednicki/spec-kit-cleanup) | +| Cognitive Squad | Multi-agent cognitive system with Triadic Model: understanding, internalization, application โ€” with quality gates, backpropagation verification, and self-healing | `docs` | Read+Write | [cognitive-squad](https://github.com/Testimonial/cognitive-squad) | +| Conduct Extension | Orchestrates spec-kit phases via sub-agent delegation to reduce context pollution. | `process` | Read+Write | [spec-kit-conduct-ext](https://github.com/twbrandon7/spec-kit-conduct-ext) | +| DocGuard โ€” CDD Enforcement | Canonical-Driven Development enforcement. Validates, scores, and traces project documentation with automated checks, AI-driven workflows, and spec-kit hooks. Zero NPM runtime dependencies. | `docs` | Read+Write | [spec-kit-docguard](https://github.com/raccioly/docguard) | +| Fleet Orchestrator | Orchestrate a full feature lifecycle with human-in-the-loop gates across all SpecKit phases | `process` | Read+Write | [spec-kit-fleet](https://github.com/sharathsatish/spec-kit-fleet) | +| Iterate | Iterate on spec documents with a two-phase define-and-apply workflow โ€” refine specs mid-implementation and go straight back to building | `docs` | Read+Write | [spec-kit-iterate](https://github.com/imviancagrace/spec-kit-iterate) | +| Jira Integration | Create Jira Epics, Stories, and Issues from spec-kit specifications and task breakdowns with configurable hierarchy and custom field support | `integration` | Read+Write | [spec-kit-jira](https://github.com/mbachorik/spec-kit-jira) | +| Learning Extension | Generate educational guides from implementations and enhance clarifications with mentoring context | `docs` | Read+Write | [spec-kit-learn](https://github.com/imviancagrace/spec-kit-learn) | +| Project Health Check | Diagnose a Spec Kit project and report health issues across structure, agents, features, scripts, extensions, and git | `visibility` | Read-only | [spec-kit-doctor](https://github.com/KhawarHabibKhan/spec-kit-doctor) | +| Project Status | Show current SDD workflow progress โ€” active feature, artifact status, task completion, workflow phase, and extensions summary | `visibility` | Read-only | [spec-kit-status](https://github.com/KhawarHabibKhan/spec-kit-status) | +| Ralph Loop | Autonomous implementation loop using AI agent CLI | `code` | Read+Write | [spec-kit-ralph](https://github.com/Rubiss/spec-kit-ralph) | +| Reconcile Extension | Reconcile implementation drift by surgically updating feature artifacts. | `docs` | Read+Write | [spec-kit-reconcile](https://github.com/stn1slv/spec-kit-reconcile) | +| Retrospective Extension | Post-implementation retrospective with spec adherence scoring, drift analysis, and human-gated spec updates | `docs` | Read+Write | [spec-kit-retrospective](https://github.com/emi-dm/spec-kit-retrospective) | +| Review Extension | Post-implementation comprehensive code review with specialized agents for code quality, comments, tests, error handling, type design, and simplification | `code` | Read-only | [spec-kit-review](https://github.com/ismaelJimenez/spec-kit-review) | +| SDD Utilities | Resume interrupted workflows, validate project health, and verify spec-to-task traceability | `process` | Read+Write | [speckit-utils](https://github.com/mvanhorn/speckit-utils) | +| Spec Sync | Detect and resolve drift between specs and implementation. AI-assisted resolution with human approval | `docs` | Read+Write | [spec-kit-sync](https://github.com/bgervin/spec-kit-sync) | +| Understanding | Automated requirements quality analysis โ€” 31 deterministic metrics against IEEE/ISO standards with experimental energy-based ambiguity detection | `docs` | Read-only | [understanding](https://github.com/Testimonial/understanding) | +| V-Model Extension Pack | Enforces V-Model paired generation of development specs and test specs with full traceability | `docs` | Read+Write | [spec-kit-v-model](https://github.com/leocamello/spec-kit-v-model) | +| Verify Extension | Post-implementation quality gate that validates implemented code against specification artifacts | `code` | Read-only | [spec-kit-verify](https://github.com/ismaelJimenez/spec-kit-verify) | +| Verify Tasks Extension | Detect phantom completions: tasks marked [X] in tasks.md with no real implementation | `code` | Read-only | [spec-kit-verify-tasks](https://github.com/datastone-inc/spec-kit-verify-tasks) | + +To submit your own extension, see the [Extension Publishing Guide](extensions/EXTENSION-PUBLISHING-GUIDE.md). + ## ๐Ÿšถ Community Walkthroughs See Spec-Driven Development in action across different scenarios with these community-contributed walkthroughs: @@ -391,7 +428,7 @@ specify extension add For example, extensions could add Jira integration, post-implementation code review, V-Model test traceability, or project health diagnostics. -See the [Extensions README](./extensions/README.md) for the full guide, the complete community catalog, and how to build and publish your own. +See the [Extensions README](./extensions/README.md) for the full guide and how to build and publish your own. Browse the [community extensions](#-community-extensions) above for what's available. ### Presets โ€” Customize Existing Workflows diff --git a/extensions/EXTENSION-DEVELOPMENT-GUIDE.md b/extensions/EXTENSION-DEVELOPMENT-GUIDE.md index feea7b278..c4af7ed15 100644 --- a/extensions/EXTENSION-DEVELOPMENT-GUIDE.md +++ b/extensions/EXTENSION-DEVELOPMENT-GUIDE.md @@ -523,7 +523,7 @@ Submit to the community catalog for public discovery: 1. **Fork** spec-kit repository 2. **Add entry** to `extensions/catalog.community.json` -3. **Update** `extensions/README.md` with your extension +3. **Update** the Community Extensions table in `README.md` with your extension 4. **Create PR** following the [Extension Publishing Guide](EXTENSION-PUBLISHING-GUIDE.md) 5. **After merge**, your extension becomes available: - Users can browse `catalog.community.json` to discover your extension diff --git a/extensions/EXTENSION-PUBLISHING-GUIDE.md b/extensions/EXTENSION-PUBLISHING-GUIDE.md index fe381e308..25801ca17 100644 --- a/extensions/EXTENSION-PUBLISHING-GUIDE.md +++ b/extensions/EXTENSION-PUBLISHING-GUIDE.md @@ -204,9 +204,9 @@ Edit `extensions/catalog.community.json` and add your extension: - Use current timestamp for `created_at` and `updated_at` - Update the top-level `updated_at` to current time -### 3. Update Extensions README +### 3. Update Community Extensions Table -Add your extension to the Available Extensions table in `extensions/README.md`: +Add your extension to the Community Extensions table in the project root `README.md`: ```markdown | Your Extension Name | Brief description of what it does | `` | | [repo-name](https://github.com/your-org/spec-kit-your-extension) | @@ -234,7 +234,7 @@ Insert your extension in alphabetical order in the table. git checkout -b add-your-extension # Commit your changes -git add extensions/catalog.community.json extensions/README.md +git add extensions/catalog.community.json README.md git commit -m "Add your-extension to community catalog - Extension ID: your-extension @@ -273,7 +273,7 @@ Brief description of what your extension does. - [x] All commands working - [x] No security vulnerabilities - [x] Added to extensions/catalog.community.json -- [x] Added to extensions/README.md Available Extensions table +- [x] Added to Community Extensions table in README.md ### Testing Tested on: diff --git a/extensions/README.md b/extensions/README.md index 25660e286..eb8c3c782 100644 --- a/extensions/README.md +++ b/extensions/README.md @@ -68,37 +68,9 @@ specify extension add --from https://github.com/org/spec-kit-ext/archive/refs/ta ## Available Community Extensions -The following community-contributed extensions are available in [`catalog.community.json`](catalog.community.json): +See the [Community Extensions](../README.md#-community-extensions) section in the main README for the full list of available community-contributed extensions. -**Categories:** `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:** `Read-only` โ€” produces reports without modifying files ยท `Read+Write` โ€” modifies files, creates artifacts, or updates specs - -| Extension | Purpose | Category | Effect | URL | -|-----------|---------|----------|--------|-----| -| Archive Extension | Archive merged features into main project memory. | `docs` | Read+Write | [spec-kit-archive](https://github.com/stn1slv/spec-kit-archive) | -| Azure DevOps Integration | Sync user stories and tasks to Azure DevOps work items using OAuth authentication | `integration` | Read+Write | [spec-kit-azure-devops](https://github.com/pragya247/spec-kit-azure-devops) | -| Checkpoint Extension | Commit the changes made during the middle of the implementation, so you don't end up with just one very large commit at the end | `code` | Read+Write | [spec-kit-checkpoint](https://github.com/aaronrsun/spec-kit-checkpoint) | -| Cleanup Extension | Post-implementation quality gate that reviews changes, fixes small issues (scout rule), creates tasks for medium issues, and generates analysis for large issues | `code` | Read+Write | [spec-kit-cleanup](https://github.com/dsrednicki/spec-kit-cleanup) | -| Cognitive Squad | Multi-agent cognitive system with Triadic Model: understanding, internalization, application โ€” with quality gates, backpropagation verification, and self-healing | `docs` | Read+Write | [cognitive-squad](https://github.com/Testimonial/cognitive-squad) | -| Conduct Extension | Orchestrates spec-kit phases via sub-agent delegation to reduce context pollution. | `process` | Read+Write | [spec-kit-conduct-ext](https://github.com/twbrandon7/spec-kit-conduct-ext) | -| DocGuard โ€” CDD Enforcement | Canonical-Driven Development enforcement. Validates, scores, and traces project documentation with automated checks, AI-driven workflows, and spec-kit hooks. Zero NPM runtime dependencies. | `docs` | Read+Write | [spec-kit-docguard](https://github.com/raccioly/docguard) | -| Fleet Orchestrator | Orchestrate a full feature lifecycle with human-in-the-loop gates across all SpecKit phases | `process` | Read+Write | [spec-kit-fleet](https://github.com/sharathsatish/spec-kit-fleet) | -| Iterate | Iterate on spec documents with a two-phase define-and-apply workflow โ€” refine specs mid-implementation and go straight back to building | `docs` | Read+Write | [spec-kit-iterate](https://github.com/imviancagrace/spec-kit-iterate) | -| Jira Integration | Create Jira Epics, Stories, and Issues from spec-kit specifications and task breakdowns with configurable hierarchy and custom field support | `integration` | Read+Write | [spec-kit-jira](https://github.com/mbachorik/spec-kit-jira) | -| Learning Extension | Generate educational guides from implementations and enhance clarifications with mentoring context | `docs` | Read+Write | [spec-kit-learn](https://github.com/imviancagrace/spec-kit-learn) | -| Project Health Check | Diagnose a Spec Kit project and report health issues across structure, agents, features, scripts, extensions, and git | `visibility` | Read-only | [spec-kit-doctor](https://github.com/KhawarHabibKhan/spec-kit-doctor) | -| Project Status | Show current SDD workflow progress โ€” active feature, artifact status, task completion, workflow phase, and extensions summary | `visibility` | Read-only | [spec-kit-status](https://github.com/KhawarHabibKhan/spec-kit-status) | -| Ralph Loop | Autonomous implementation loop using AI agent CLI | `code` | Read+Write | [spec-kit-ralph](https://github.com/Rubiss/spec-kit-ralph) | -| Reconcile Extension | Reconcile implementation drift by surgically updating feature artifacts. | `docs` | Read+Write | [spec-kit-reconcile](https://github.com/stn1slv/spec-kit-reconcile) | -| Retrospective Extension | Post-implementation retrospective with spec adherence scoring, drift analysis, and human-gated spec updates | `docs` | Read+Write | [spec-kit-retrospective](https://github.com/emi-dm/spec-kit-retrospective) | -| Review Extension | Post-implementation comprehensive code review with specialized agents for code quality, comments, tests, error handling, type design, and simplification | `code` | Read-only | [spec-kit-review](https://github.com/ismaelJimenez/spec-kit-review) | -| SDD Utilities | Resume interrupted workflows, validate project health, and verify spec-to-task traceability | `process` | Read+Write | [speckit-utils](https://github.com/mvanhorn/speckit-utils) | -| Spec Sync | Detect and resolve drift between specs and implementation. AI-assisted resolution with human approval | `docs` | Read+Write | [spec-kit-sync](https://github.com/bgervin/spec-kit-sync) | -| Understanding | Automated requirements quality analysis โ€” 31 deterministic metrics against IEEE/ISO standards with experimental energy-based ambiguity detection | `docs` | Read-only | [understanding](https://github.com/Testimonial/understanding) | -| V-Model Extension Pack | Enforces V-Model paired generation of development specs and test specs with full traceability | `docs` | Read+Write | [spec-kit-v-model](https://github.com/leocamello/spec-kit-v-model) | -| Verify Extension | Post-implementation quality gate that validates implemented code against specification artifacts | `code` | Read-only | [spec-kit-verify](https://github.com/ismaelJimenez/spec-kit-verify) | -| Verify Tasks Extension | Detect phantom completions: tasks marked [X] in tasks.md with no real implementation | `code` | Read-only | [spec-kit-verify-tasks](https://github.com/datastone-inc/spec-kit-verify-tasks) | +For the raw catalog data, see [`catalog.community.json`](catalog.community.json). ## Adding Your Extension