Skip to content

πŸ’« Toolkit to help you get started with SDD or any other process!

docs: merge TESTING.md into CONTRIBUTING.md, remove TESTING.md (#2228)

Manfred Riemb78a3cdd88f3
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 9044ef5ff..4ce19657e 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -44,8 +44,7 @@ On [GitHub Codespaces](https://github.com/features/codespaces) it's even simpler
1. Push to your fork and submit a pull request
1. Wait for your pull request to be reviewed and merged.
-For the detailed test workflow, command-selection prompt, and PR reporting template, see [`TESTING.md`](./TESTING.md).
-Activate the project virtual environment (see the Setup block in [`TESTING.md`](./TESTING.md)), then install the CLI from your working tree (`uv pip install -e .` after `uv sync --extra test`) or otherwise ensure the shell uses the local `specify` binary before running the manual slash-command tests described below.
+Activate the project virtual environment (see [Testing setup](#testing-setup) below), then install the CLI from your working tree (`uv pip install -e .` after `uv sync --extra test`) or otherwise ensure the shell uses the local `specify` binary before running the manual slash-command tests described below.
Here are a few things you can do that will increase the likelihood of your pull request being accepted:
@@ -69,34 +68,99 @@ When working on spec-kit:
For the smoothest review experience, validate changes in this order:
-1. **Run focused automated checks first** β€” use the quick verification commands in [`TESTING.md`](./TESTING.md) to catch packaging, scaffolding, and configuration regressions early.
-2. **Run manual workflow tests second** β€” if your change affects slash commands or the developer workflow, follow [`TESTING.md`](./TESTING.md) to choose the right commands, run them in an agent, and capture results for your PR.
-3. **Use local release packages when debugging packaged output** β€” if you need to inspect the exact files CI-style packaging produces, generate local release packages as described below.
+1. **Run focused automated checks first** β€” use the quick verification commands [below](#automated-checks) to catch scaffolding and configuration regressions early.
+2. **Run manual workflow tests second** β€” if your change affects slash commands or the developer workflow, follow the [manual testing](#manual-testing) section to choose the right commands, run them in an agent, and capture results for your PR.
-### Testing template and command changes locally
+### Automated checks
-Running `uv run specify init` pulls released packages, which won’t include your local changes.
-To test your templates, commands, and other changes locally, follow these steps:
+#### Agent configuration and wiring consistency
-1. **Create release packages**
+```bash
+uv run python -m pytest tests/test_agent_config_consistency.py -q
+```
- Run the following command to generate the local packages:
+Run this when you change agent metadata, context update scripts, or integration wiring.
- ```bash
- ./.github/workflows/scripts/create-release-packages.sh v1.0.0
- ```
+### Manual testing
-2. **Copy the relevant package to your test project**
+#### Testing setup
- ```bash
- cp -r .genreleases/sdd-copilot-package-sh/. <path-to-test-project>/
- ```
+```bash
+# Install the project and test dependencies from your local branch
+cd <spec-kit-repo>
+uv sync --extra test
+source .venv/bin/activate # On Windows (CMD): .venv\Scripts\activate | (PowerShell): .venv\Scripts\Activate.ps1
+uv pip install -e .
+# Ensure the `specify` binary in this environment points at your working tree so the agent runs the branch you're testing.
-3. **Open and test the agent**
+# Initialize a test project using your local changes
+uv run specify init <temp-dir>/speckit-test --ai <agent> --offline
+cd <temp-dir>/speckit-test
- Navigate to your test project folder and open the agent to verify your implementation.
+# Open in your agent
+```
-If you only need to validate generated file structure and content before doing manual agent testing, start with the focused automated checks in [`TESTING.md`](./TESTING.md). Keep this section for the cases where you need to inspect the exact packaged output locally.
+#### Manual testing process
+
+Any change that affects a slash command's behavior requires manually testing that command through an AI agent and submitting results with the PR.
+
+1. **Identify affected commands** β€” use the [prompt below](#determining-which-tests-to-run) to have your agent analyze your changed files and determine which commands need testing.
+2. **Set up a test project** β€” scaffold from your local branch (see [Testing setup](#testing-setup)).
+3. **Run each affected command** β€” invoke it in your agent, verify it completes successfully, and confirm it produces the expected output (files created, scripts executed, artifacts populated).
+4. **Run prerequisites first** β€” commands that depend on earlier commands (e.g., `/speckit.tasks` requires `/speckit.plan` which requires `/speckit.specify`) must be run in order.
+5. **Report results** β€” paste the [reporting template](#reporting-results) into your PR with pass/fail for each command tested.
+
+#### Reporting results
+
+Paste this into your PR:
+
+~~~markdown
+## Manual test results
+
+**Agent**: [e.g., GitHub Copilot in VS Code] | **OS/Shell**: [e.g., macOS/zsh]
+
+| Command tested | Notes |
+|----------------|-------|
+| `/speckit.command` | |
+~~~
+
+#### Determining which tests to run
+
+Copy this prompt into your agent. Include the agent's response (selected tests plus a brief explanation of the mapping) in your PR.
+
+~~~text
+Read CONTRIBUTING.md, then run `git diff --name-only main` to get my changed files.
+For each changed file, determine which slash commands it affects by reading
+the command templates in templates/commands/ to understand what each command
+invokes. Use these mapping rules:
+
+- templates/commands/X.md β†’ the command it defines
+- scripts/bash/Y.sh or scripts/powershell/Y.ps1 β†’ every command that invokes that script (grep templates/commands/ for the script name). Also check transitive dependencies: if the changed script is sourced by other scripts (e.g., common.sh is sourced by create-new-feature.sh, check-prerequisites.sh, setup-plan.sh, update-agent-context.sh), then every command invoking those downstream scripts is also affected
+- templates/Z-template.md β†’ every command that consumes that template during execution
+- src/specify_cli/*.py β†’ CLI commands (`specify init`, `specify check`, `specify extension *`, `specify preset *`); test the affected CLI command and, for init/scaffolding changes, at minimum test /speckit.specify
+- extensions/X/commands/* β†’ the extension command it defines
+- extensions/X/scripts/* β†’ every extension command that invokes that script
+- extensions/X/extension.yml or config-template.yml β†’ every command in that extension. Also check if the manifest defines hooks (look for `hooks:` entries like `before_specify`, `after_implement`, etc.) β€” if so, the core commands those hooks attach to are also affected
+- presets/*/* β†’ test preset scaffolding via `specify init` with the preset
+- pyproject.toml β†’ packaging/bundling; test `specify init` and verify bundled assets
+
+Include prerequisite tests (e.g., T5 requires T3 requires T1).
+
+Output in this format:
+
+### Test selection reasoning
+
+| Changed file | Affects | Test | Why |
+|---|---|---|---|
+| (path) | (command) | T# | (reason) |
+
+### Required tests
+
+Number each test sequentially (T1, T2, ...). List prerequisite tests first.
+
+- T1: /speckit.command β€” (reason)
+- T2: /speckit.command β€” (reason)
+~~~
## AI contributions in Spec Kit
diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md
index dc35bc6fe..946e071e3 100644
--- a/DEVELOPMENT.md
+++ b/DEVELOPMENT.md
@@ -11,8 +11,7 @@ Spec Kit is a toolkit for spec-driven development. At its core, it is a coordina
| [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. |
+| [CONTRIBUTING.md](CONTRIBUTING.md) | Contribution process, review expectations, testing, and required development practices. |
**Main repository components:**
diff --git a/TESTING.md b/TESTING.md
deleted file mode 100644
index 1fa6b1c88..000000000
--- a/TESTING.md
+++ /dev/null
@@ -1,133 +0,0 @@
-# Testing Guide
-
-This document is the detailed testing companion to [`CONTRIBUTING.md`](./CONTRIBUTING.md).
-
-Use it for three things:
-
-1. running quick automated checks before manual testing,
-2. manually testing affected slash commands through an AI agent, and
-3. capturing the results in a PR-friendly format.
-
-Any change that affects a slash command's behavior requires manually testing that command through an AI agent and submitting results with the PR.
-
-## Recommended order
-
-1. **Sync your environment** β€” install the project and test dependencies.
-2. **Run focused automated checks** β€” especially for packaging, scaffolding, agent config, and generated-file changes.
-3. **Run manual agent tests** β€” for any affected slash commands.
-4. **Paste results into your PR** β€” include both command-selection reasoning and manual test results.
-
-## Quick automated checks
-
-Run these before manual testing when your change affects packaging, scaffolding, templates, release artifacts, or agent wiring.
-
-### Environment setup
-
-```bash
-cd <spec-kit-repo>
-uv sync --extra test
-source .venv/bin/activate # On Windows (CMD): .venv\Scripts\activate | (PowerShell): .venv\Scripts\Activate.ps1
-```
-
-### Generated package structure and content
-
-```bash
-uv run python -m pytest tests/test_core_pack_scaffold.py -q
-```
-
-This validates the generated files that CI-style packaging depends on, including directory layout, file names, frontmatter/TOML validity, placeholder replacement, `.specify/` path rewrites, and parity with `create-release-packages.sh`.
-
-### Agent configuration and release wiring consistency
-
-```bash
-uv run python -m pytest tests/test_agent_config_consistency.py -q
-```
-
-Run this when you change agent metadata, release scripts, context update scripts, or artifact naming.
-
-### Optional single-agent packaging spot check
-
-```bash
-AGENTS=copilot SCRIPTS=sh ./.github/workflows/scripts/create-release-packages.sh v1.0.0
-```
-
-Inspect `.genreleases/sdd-copilot-package-sh/` and the matching ZIP in `.genreleases/` when you want to review the exact packaged output for one agent/script combination.
-
-## Manual testing process
-
-1. **Identify affected commands** β€” use the [prompt below](#determining-which-tests-to-run) to have your agent analyze your changed files and determine which commands need testing.
-2. **Set up a test project** β€” scaffold from your local branch (see [Setup](#setup)).
-3. **Run each affected command** β€” invoke it in your agent, verify it completes successfully, and confirm it produces the expected output (files created, scripts executed, artifacts populated).
-4. **Run prerequisites first** β€” commands that depend on earlier commands (e.g., `/speckit.tasks` requires `/speckit.plan` which requires `/speckit.specify`) must be run in order.
-5. **Report results** β€” paste the [reporting template](#reporting-results) into your PR with pass/fail for each command tested.
-
-## Setup
-
-```bash
-# Install the project and test dependencies from your local branch
-cd <spec-kit-repo>
-uv sync --extra test
-source .venv/bin/activate # On Windows (CMD): .venv\Scripts\activate | (PowerShell): .venv\Scripts\Activate.ps1
-uv pip install -e .
-# Ensure the `specify` binary in this environment points at your working tree so the agent runs the branch you're testing.
-
-# Initialize a test project using your local changes
-uv run specify init /tmp/speckit-test --ai <agent> --offline
-cd /tmp/speckit-test
-
-# Open in your agent
-```
-
-If you are testing the packaged output rather than the live source tree, create a local release package first as described in [`CONTRIBUTING.md`](./CONTRIBUTING.md).
-
-## Reporting results
-
-Paste this into your PR:
-
-~~~markdown
-## Manual test results
-
-**Agent**: [e.g., GitHub Copilot in VS Code] | **OS/Shell**: [e.g., macOS/zsh]
-
-| Command tested | Notes |
-|----------------|-------|
-| `/speckit.command` | |
-~~~
-
-## Determining which tests to run
-
-Copy this prompt into your agent. Include the agent's response (selected tests plus a brief explanation of the mapping) in your PR.
-
-~~~text
-Read TESTING.md, then run `git diff --name-only main` to get my changed files.
-For each changed file, determine which slash commands it affects by reading
-the command templates in templates/commands/ to understand what each command
-invokes. Use these mapping rules:
-
-- templates/commands/X.md β†’ the command it defines
-- scripts/bash/Y.sh or scripts/powershell/Y.ps1 β†’ every command that invokes that script (grep templates/commands/ for the script name). Also check transitive dependencies: if the changed script is sourced by other scripts (e.g., common.sh is sourced by create-new-feature.sh, check-prerequisites.sh, setup-plan.sh, update-agent-context.sh), then every command invoking those downstream scripts is also affected
-- templates/Z-template.md β†’ every command that consumes that template during execution
-- src/specify_cli/*.py β†’ CLI commands (`specify init`, `specify check`, `specify extension *`, `specify preset *`); test the affected CLI command and, for init/scaffolding changes, at minimum test /speckit.specify
-- extensions/X/commands/* β†’ the extension command it defines
-- extensions/X/scripts/* β†’ every extension command that invokes that script
-- extensions/X/extension.yml or config-template.yml β†’ every command in that extension. Also check if the manifest defines hooks (look for `hooks:` entries like `before_specify`, `after_implement`, etc.) β€” if so, the core commands those hooks attach to are also affected
-- presets/*/* β†’ test preset scaffolding via `specify init` with the preset
-- pyproject.toml β†’ packaging/bundling; test `specify init` and verify bundled assets
-
-Include prerequisite tests (e.g., T5 requires T3 requires T1).
-
-Output in this format:
-
-### Test selection reasoning
-
-| Changed file | Affects | Test | Why |
-|---|---|---|---|
-| (path) | (command) | T# | (reason) |
-
-### Required tests
-
-Number each test sequentially (T1, T2, ...). List prerequisite tests first.
-
-- T1: /speckit.command β€” (reason)
-- T2: /speckit.command β€” (reason)
-~~~