mirror of
https://github.com/github/spec-kit.git
synced 2026-07-03 12:28:06 +08:00
docs: consolidate Community sections in README (#2736)
* docs: consolidate Community sections in README Replace four separate Community sections (Extensions, Presets, Walkthroughs, Friends) with a single consolidated section containing a bullet list, one shared disclaimer, and both publishing guide links. * fix: broken community anchor links and missing Hermes hook note injection - Update README.md and extensions/README.md to point community extension links to the docs site instead of removed section anchor - Add post_process_skill_content() call in Hermes setup() so hook command notes are injected into generated skills - Add Hermes test override for test_hook_sections_explain_dotted_command_conversion with Path.home() monkeypatch
This commit is contained in:
37
README.md
37
README.md
@@ -22,10 +22,7 @@
|
|||||||
- [🤔 What is Spec-Driven Development?](#-what-is-spec-driven-development)
|
- [🤔 What is Spec-Driven Development?](#-what-is-spec-driven-development)
|
||||||
- [⚡ Get Started](#-get-started)
|
- [⚡ Get Started](#-get-started)
|
||||||
- [📽️ Video Overview](#️-video-overview)
|
- [📽️ Video Overview](#️-video-overview)
|
||||||
- [🧩 Community Extensions](#-community-extensions)
|
- [🌍 Community](#-community)
|
||||||
- [🎨 Community Presets](#-community-presets)
|
|
||||||
- [🚶 Community Walkthroughs](#-community-walkthroughs)
|
|
||||||
- [🛠️ Community Friends](#️-community-friends)
|
|
||||||
- [🤖 Supported AI Coding Agent Integrations](#-supported-ai-coding-agent-integrations)
|
- [🤖 Supported AI Coding Agent Integrations](#-supported-ai-coding-agent-integrations)
|
||||||
- [🔧 Specify CLI Reference](#-specify-cli-reference)
|
- [🔧 Specify CLI Reference](#-specify-cli-reference)
|
||||||
- [🧩 Making Spec Kit Your Own: Extensions & Presets](#-making-spec-kit-your-own-extensions--presets)
|
- [🧩 Making Spec Kit Your Own: Extensions & Presets](#-making-spec-kit-your-own-extensions--presets)
|
||||||
@@ -112,31 +109,19 @@ Want to see Spec Kit in action? Watch our [video overview](https://www.youtube.c
|
|||||||
|
|
||||||
[](https://www.youtube.com/watch?v=a9eR1xsfvHg&pp=0gcJCckJAYcqIYzv)
|
[](https://www.youtube.com/watch?v=a9eR1xsfvHg&pp=0gcJCckJAYcqIYzv)
|
||||||
|
|
||||||
## 🧩 Community Extensions
|
## 🌍 Community
|
||||||
|
|
||||||
Community-contributed extensions add new commands, hooks, and capabilities to Spec Kit. See the full list on the [Community Extensions](https://github.github.io/spec-kit/community/extensions.html) page.
|
Explore community-contributed resources on the [Spec Kit docs site](https://github.github.io/spec-kit/):
|
||||||
|
|
||||||
|
- [Extensions](https://github.github.io/spec-kit/community/extensions.html) — commands, hooks, and capabilities
|
||||||
|
- [Presets](https://github.github.io/spec-kit/community/presets.html) — template and terminology overrides
|
||||||
|
- [Walkthroughs](https://github.github.io/spec-kit/community/walkthroughs.html) — end-to-end SDD scenarios
|
||||||
|
- [Friends](https://github.github.io/spec-kit/community/friends.html) — projects that extend or build on Spec Kit
|
||||||
|
|
||||||
> [!NOTE]
|
> [!NOTE]
|
||||||
> Community extensions are independently created and maintained by their respective authors. Maintainers only verify that catalog entries are complete and correctly formatted — they do **not review, audit, endorse, or support the extension code itself**. Review extension source code before installation and use at your own discretion.
|
> Community contributions are independently created and maintained by their respective authors. Review source code before installation and use at your own discretion.
|
||||||
|
|
||||||
To submit your own extension, see the [Extension Publishing Guide](extensions/EXTENSION-PUBLISHING-GUIDE.md).
|
Want to contribute? See the [Extension Publishing Guide](extensions/EXTENSION-PUBLISHING-GUIDE.md) or the [Presets Publishing Guide](presets/PUBLISHING.md).
|
||||||
|
|
||||||
## 🎨 Community Presets
|
|
||||||
|
|
||||||
Community-contributed presets customize how Spec Kit behaves — overriding templates, commands, and terminology without changing any tooling. See the full list on the [Community Presets](https://github.github.io/spec-kit/community/presets.html) page.
|
|
||||||
|
|
||||||
> [!NOTE]
|
|
||||||
> Community presets are third-party contributions and are not maintained by the Spec Kit team. Review them carefully before use, and see the docs page above for the full disclaimer.
|
|
||||||
|
|
||||||
To submit your own preset, see the [Presets Publishing Guide](presets/PUBLISHING.md).
|
|
||||||
|
|
||||||
## 🚶 Community Walkthroughs
|
|
||||||
|
|
||||||
See Spec-Driven Development in action across different scenarios with community-contributed walkthroughs; find the full list on the [Community Walkthroughs](https://github.github.io/spec-kit/community/walkthroughs.html) page.
|
|
||||||
|
|
||||||
## 🛠️ Community Friends
|
|
||||||
|
|
||||||
Community projects that extend, visualize, or build on Spec Kit. See the full list on the [Community Friends](https://github.github.io/spec-kit/community/friends.html) page.
|
|
||||||
|
|
||||||
## 🤖 Supported AI Coding Agent Integrations
|
## 🤖 Supported AI Coding Agent Integrations
|
||||||
|
|
||||||
@@ -206,7 +191,7 @@ specify extension add <extension-name>
|
|||||||
|
|
||||||
For example, extensions could add Jira integration, post-implementation code review, V-Model test traceability, or project health diagnostics.
|
For example, extensions could add Jira integration, post-implementation code review, V-Model test traceability, or project health diagnostics.
|
||||||
|
|
||||||
See the [Extensions reference](https://github.github.io/spec-kit/reference/extensions.html) for the full command guide. Browse the [community extensions](#-community-extensions) above for what's available.
|
See the [Extensions reference](https://github.github.io/spec-kit/reference/extensions.html) for the full command guide. Browse the [community extensions](https://github.github.io/spec-kit/community/extensions.html) for what's available.
|
||||||
|
|
||||||
### Presets — Customize Existing Workflows
|
### Presets — Customize Existing Workflows
|
||||||
|
|
||||||
|
|||||||
@@ -76,7 +76,7 @@ specify extension add <extension-name> --from https://github.com/org/spec-kit-ex
|
|||||||
|
|
||||||
🔍 **Browse and search community extensions on the [Community Extensions website](https://speckit-community.github.io/extensions/).**
|
🔍 **Browse and search community extensions on the [Community Extensions website](https://speckit-community.github.io/extensions/).**
|
||||||
|
|
||||||
See the [Community Extensions](../README.md#-community-extensions) section in the main README for the full list of available community-contributed extensions.
|
See the [Community Extensions](https://github.github.io/spec-kit/community/extensions.html) page for the full list of available community-contributed extensions.
|
||||||
|
|
||||||
For the raw catalog data, see [`catalog.community.json`](catalog.community.json).
|
For the raw catalog data, see [`catalog.community.json`](catalog.community.json).
|
||||||
|
|
||||||
|
|||||||
@@ -172,6 +172,8 @@ class HermesIntegration(SkillsIntegration):
|
|||||||
f"{processed_body}"
|
f"{processed_body}"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
skill_content = self.post_process_skill_content(skill_content)
|
||||||
|
|
||||||
# Write directly to global ~/.hermes/skills/speckit-<name>/SKILL.md
|
# Write directly to global ~/.hermes/skills/speckit-<name>/SKILL.md
|
||||||
skill_dir = global_skills_dir / skill_name
|
skill_dir = global_skills_dir / skill_name
|
||||||
skill_dir.mkdir(parents=True, exist_ok=True)
|
skill_dir.mkdir(parents=True, exist_ok=True)
|
||||||
|
|||||||
@@ -197,6 +197,24 @@ class TestHermesIntegration(SkillsIntegrationTests):
|
|||||||
"Foreign skill was removed by teardown"
|
"Foreign skill was removed by teardown"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
def test_hook_sections_explain_dotted_command_conversion(self, tmp_path, monkeypatch):
|
||||||
|
"""Override: Hermes skills live in global ~/.hermes/skills/."""
|
||||||
|
home = _fake_home(tmp_path)
|
||||||
|
monkeypatch.setattr(Path, "home", lambda: home)
|
||||||
|
|
||||||
|
i = get_integration(self.KEY)
|
||||||
|
m = IntegrationManifest(self.KEY, tmp_path)
|
||||||
|
i.setup(tmp_path, m)
|
||||||
|
specify_skill = home / ".hermes" / "skills" / "speckit-specify" / "SKILL.md"
|
||||||
|
assert specify_skill.exists()
|
||||||
|
content = specify_skill.read_text(encoding="utf-8")
|
||||||
|
assert "replace dots" in content, (
|
||||||
|
"speckit-specify should explain dotted hook command conversion"
|
||||||
|
)
|
||||||
|
assert content.count("replace dots") == content.count(
|
||||||
|
"- For each executable hook, output the following"
|
||||||
|
)
|
||||||
|
|
||||||
def test_complete_file_inventory_sh(self, tmp_path, monkeypatch):
|
def test_complete_file_inventory_sh(self, tmp_path, monkeypatch):
|
||||||
"""Override: Hermes init produces no local SKILL.md files,
|
"""Override: Hermes init produces no local SKILL.md files,
|
||||||
only the empty .hermes/skills/ marker."""
|
only the empty .hermes/skills/ marker."""
|
||||||
|
|||||||
Reference in New Issue
Block a user