Skip to content

Latest commit

聽

History

History
58 lines (40 loc) 路 2.79 KB

File metadata and controls

58 lines (40 loc) 路 2.79 KB

AGENTS.md

About Spec Kit and Specify

GitHub Spec Kit is a comprehensive toolkit for implementing Spec-Driven Development (SDD) - a methodology that emphasizes creating clear specifications before implementation. The toolkit includes templates, scripts, and workflows that guide development teams through a structured approach to building software.

Specify CLI is the command-line interface that bootstraps projects with the Spec Kit framework. It sets up the necessary directory structures, templates, and AI agent integrations to support the Spec-Driven Development workflow.

The toolkit supports multiple AI coding assistants, allowing teams to use their preferred tools while maintaining consistent project structure and development practices.

Adding or Updating CLI Commands

Before adding, updating, or reorganizing Specify CLI commands, read Specify CLI Command Architecture. It defines command-module naming, private command phases, nested command groups, registration ownership, mirrored tests, and the rationale for making the CLI structure predictable for both humans and coding agents.

Adding or Updating Agent Integrations

Before adding or changing AI agent integrations, read Agent Integration Design. It covers delivery routes, output formats, registration, and install/uninstall ownership.

Adding or Updating Workflow Steps

Before adding or changing workflow step types, read Workflow Step Design. It covers registration, validation, execution, resume, and installed step packages.

Testing Executable Behavior

Before changing code or configuration that runs or controls execution without an LLM, read Testing deterministic behavior. Behavioral changes need positive and negative coverage; bug fixes need before-and-after regression evidence.

Branches and Agent Contributions

When creating a branch, follow Branch naming. Before authoring commits, opening PRs, or posting review comments, read Agent-authored Git and review activity. Agent-authored commits and AI-generated PRs and comments each require their own disclosure; a PR-body disclosure alone does not cover later activity.

Other Contribution Guidance

For contribution or repository-workflow questions not covered above, or when the applicable guidance is unclear, read CONTRIBUTING.md before acting.

Common Pitfalls

  • Running tests against the wrong environment: Run the suite inside this worktree's own virtualenv (uv sync --extra test then .venv/bin/python -m pytest). A bare uv run pytest can pick up an editable install from another worktree and fail to import new subpackages.