Skip to content

Commit 08f69e3

Browse files
authored
Introduces DEVELOPMENT.md (#2069)
* Create DEVELOPMENT.md outline * AI-generated DEVELOPMENT.md draft * Update DEVELOPMENT.md * Update DEVELOPMENT.md * Create Untitled 2.md * Update DEVELOPMENT.md * Update DEVELOPMENT.md * Update DEVELOPMENT.md * Update DEVELOPMENT.md * Update DEVELOPMENT.md * Update DEVELOPMENT.md * Compact DEVELOPMENT.md * Create DEVELOPMENT.md outline * AI-generated DEVELOPMENT.md draft * Update DEVELOPMENT.md * Update DEVELOPMENT.md * Create Untitled 2.md * Update DEVELOPMENT.md * Update DEVELOPMENT.md * Update DEVELOPMENT.md * Update DEVELOPMENT.md * Update DEVELOPMENT.md * Update DEVELOPMENT.md * Compact DEVELOPMENT.md * Update DEVELOPMENT.md
1 parent c8ccb06 commit 08f69e3

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

DEVELOPMENT.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Development Notes
2+
3+
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.
4+
5+
**Essential project documents:**
6+
7+
| Document | Role |
8+
| ---------------------------------------------------------- | ------------------------------------------------------------------------------------- |
9+
| [README.md](README.md) | Primary user-facing overview of Spec Kit and its workflow. |
10+
| [DEVELOPMENT.md](DEVELOPMENT.md) | This document. |
11+
| [spec-driven.md](spec-driven.md) | End-to-end explanation of the Spec-Driven Development workflow supported by Spec Kit. |
12+
| [RELEASE-PROCESS.md](.github/workflows/RELEASE-PROCESS.md) | Release workflow, versioning rules, and changelog generation process. |
13+
| [docs/index.md](docs/index.md) | Entry point to the `docs/` documentation set. |
14+
| [CONTRIBUTING.md](CONTRIBUTING.md) | Contribution process, review expectations, and required development practices. |
15+
| [TESTING.md](TESTING.md) | Validation strategy and testing procedures. |
16+
17+
**Main repository components:**
18+
19+
| Directory | Role |
20+
| ------------------ | ------------------------------------------------------------------------------------------- |
21+
| `templates/` | Prompt assets and templates that define the core workflow behavior and generated artifacts. |
22+
| `scripts/` | Supporting scripts used by the workflow, setup, and repository tooling. |
23+
| `src/specify_cli/` | Python source for the `specify` CLI, including agent-specific assets. |
24+
| `extensions/` | Extension-related docs, catalogs, and supporting assets. |
25+
| `presets/` | Preset-related docs, catalogs, and supporting assets. |

0 commit comments

Comments
 (0)