mcpField
G
github-spec-kit

github-spec-kit

github.com/doitundoit开发058 次安装40 周前更新
代码仓库

关于 github-spec-kit

github-spec-kit 是引导使用 GitHub Spec Kit 开展规范驱动开发的 Skill,涵盖项目初始化、原则制定、规划、任务拆分和实现。适合希望先明确场景与需求再编写代码的团队。

主要功能

  1. 01初始化项目
  2. 02制定项目原则
  3. 03编写功能规范
  4. 04制定技术计划
  5. 05拆分任务并实现

适用场景

  1. 01启动新的软件项目
  2. 02在实现前明确需求
  3. 03将计划转为可验证任务

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/doitundoit/github-spec-kit --skill github-spec-kit

安装后在 Claude Code 中输入/github-spec-kit确认已加载。

附带文件references/workflow.mdREADME.md

详细介绍

Github Spec Kit

概述

本技能介绍如何使用 GitHub Spec Kit 推进规范驱动开发(SDD)。它帮助你从代码优先转向规范优先的开发方式,通过专注于产品场景和可预测的结果来确保软件质量。

工作流

Github Spec Kit 工作流包含以下关键阶段。开发新功能或新项目时,请按顺序执行。

  1. 初始化:设置项目结构。
  2. 章程:定义项目原则。
  3. 编写规范:创建功能规范。
  4. 规划:设计技术实现方案。
  5. 任务:将计划拆分为可执行的任务。
  6. 实现:执行任务。

每个步骤的详细说明请参阅 WORKFLOW.md。

使用指南

1. 初始化
  • 目标:启动新项目。
  • 操作:使用 uvx --from specify-cli specify init . --here --ai [MODEL]。
  • Git 检查:执行前,检查目录是否已经是 git 仓库(例如,git rev-parse --is-inside-work-tree)。只有在 git 仓库已初始化时,才使用 --no-git 标记,以避免冲突。
  • 检查:确保可以使用 specify-cli;为保持一致性,优先使用 uvx。
2. 原则(章程)
  • 目标:确立指导原则。
  • 触发方式:响应 /speckit.constitution。
  • 操作:创建或更新 .specify/memory/constitution.md。
  • 重点:定义代码质量、测试标准和性能等核心价值观。
3. 规范
  • 目标:描述“是什么”和“为什么”。
  • 触发方式:响应 /speckit.specify。
  • 操作:使用 .specify/templates/spec-template.md 中的模板创建 specs/<feature>/spec.md。
  • 重点:用户场景、结果和功能需求。避免涉及实现细节。
4. 规划
  • 目标:定义“如何实现”。
  • 触发方式:响应 /speckit.plan。
  • 操作:创建 specs/<feature>/plan.md(以及可选的 data-model.md、research.md)。
  • 重点:架构、技术栈、数据结构和算法。
5. 任务
  • 目标:创建检查清单。
  • 触发方式:响应 /speckit.tasks。
  • 操作:根据计划和规范创建 specs/<feature>/tasks.md。
  • 重点:按用户故事分组的小型、可验证步骤。
6. 实现
  • 目标:编写代码。
  • 触发方式:响应 /speckit.implement。
  • 操作:按顺序执行 tasks.md 中的任务。
  • 行为:读取当前任务、完成实现、验证,并将其标记为已完成。

资源

评论

支持 Markdown