mirror of
https://github.com/github/spec-kit.git
synced 2026-07-04 04:45:43 +08:00
b78a3cdd88
* docs: merge TESTING.md into CONTRIBUTING.md, remove TESTING.md Merge relevant testing content (automated checks, manual testing process, reporting template, test-selection prompt) into CONTRIBUTING.md. Remove obsolete content referencing deleted zip bundles and the non-existent test_core_pack_scaffold.py file. Update DEVELOPMENT.md to remove the TESTING.md entry. Closes #2226 * docs: address review — narrow automated checks intro, use cross-platform temp path
2.4 KiB
2.4 KiB
Development Notes
Spec Kit is a toolkit for spec-driven development. At its core, it is a coordinated set of prompts, templates, scripts, and CLI/integration assets that define and deliver a spec-driven workflow for AI coding agents. This document is a starting point for people modifying Spec Kit itself, with a compact orientation to the key project documents and repository organization.
Essential project documents:
| Document | Role |
|---|---|
| README.md | Primary user-facing overview of Spec Kit and its workflow. |
| DEVELOPMENT.md | This document. |
| spec-driven.md | End-to-end explanation of the Spec-Driven Development workflow supported by Spec Kit. |
| RELEASE-PROCESS.md | Release workflow, versioning rules, and changelog generation process. |
| docs/index.md | Entry point to the docs/ documentation set. |
| CONTRIBUTING.md | Contribution process, review expectations, testing, and required development practices. |
Main repository components:
| Directory | Role |
|---|---|
templates/ |
Prompt assets and templates that define the core workflow behavior and generated artifacts. |
scripts/ |
Supporting scripts used by the workflow, setup, and repository tooling. |
src/specify_cli/ |
Python source for the specify CLI, including agent-specific assets. |
extensions/ |
Extension-related docs, catalogs, and supporting assets. |
presets/ |
Preset-related docs, catalogs, and supporting assets. |