diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md new file mode 100644 index 000000000..dc35bc6fe --- /dev/null +++ b/DEVELOPMENT.md @@ -0,0 +1,25 @@ +# 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](README.md) | Primary user-facing overview of Spec Kit and its workflow. | +| [DEVELOPMENT.md](DEVELOPMENT.md) | This document. | +| [spec-driven.md](spec-driven.md) | End-to-end explanation of the Spec-Driven Development workflow supported by Spec Kit. | +| [RELEASE-PROCESS.md](.github/workflows/RELEASE-PROCESS.md) | Release workflow, versioning rules, and changelog generation process. | +| [docs/index.md](docs/index.md) | Entry point to the `docs/` documentation set. | +| [CONTRIBUTING.md](CONTRIBUTING.md) | Contribution process, review expectations, and required development practices. | +| [TESTING.md](TESTING.md) | Validation strategy and testing procedures. | + +**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. |