@glxmart/boss-cli 1.0.0-beta.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +134 -0
- package/assets/claude-folder/agents/.gitkeep +0 -0
- package/assets/claude-folder/commands/boss-commands.md +138 -0
- package/assets/claude-folder/rules/boss-workflow.md +33 -0
- package/assets/claude-folder/rules/code-style.md +23 -0
- package/assets/claude-folder/rules/security.md +22 -0
- package/assets/claude-folder/rules/testing.md +32 -0
- package/assets/claude-folder/settings.local.json +88 -0
- package/assets/claude-folder/skills/.gitkeep +0 -0
- package/assets/claude-md/docs/container-use.md +140 -0
- package/assets/claude-md/docs/github-operations.md +238 -0
- package/assets/claude-md/docs/initialization.md +186 -0
- package/assets/claude-md/docs/quality-standards.md +15 -0
- package/assets/claude-md/docs/spec-kit.md +46 -0
- package/assets/claude-md/docs/workers.md +174 -0
- package/assets/claude-md/docs/workflow.md +140 -0
- package/assets/claude-md/template.md +812 -0
- package/assets/docker-compose/docker-compose.yml +52 -0
- package/assets/git-hooks/commit-msg.sh +102 -0
- package/assets/git-hooks/pre-commit-check.sh +21 -0
- package/assets/git-hooks/pre-commit.sh +6 -0
- package/assets/git-hooks/pre-push.sh +154 -0
- package/assets/git-hooks/security-check.sh +40 -0
- package/assets/git-hooks/test-changed.sh +84 -0
- package/assets/github-workflows/CODEOWNERS +3 -0
- package/assets/github-workflows/boss-ci.yml +40 -0
- package/assets/github-workflows/boss-gates.yml +28 -0
- package/assets/start-boss-sh/start-boss.sh +471 -0
- package/assets/template-docs/api-service-fastify.md +98 -0
- package/assets/template-docs/blank.md +91 -0
- package/assets/template-docs/nextjs-app-turbo.md +102 -0
- package/assets/template-docs/t3-app.md +106 -0
- package/assets/template-loader/README.md +28 -0
- package/assets/template-loader/eslint.config.node.js +28 -0
- package/assets/template-loader/eslint.config.react.js +47 -0
- package/assets/template-loader/gitignore +42 -0
- package/assets/template-loader/index.test.ts +10 -0
- package/assets/template-loader/index.ts +13 -0
- package/assets/template-loader/prettierignore +8 -0
- package/assets/template-loader/vitest.config.ts +19 -0
- package/assets/worker-configs/architect/.claude/commands/.gitkeep +0 -0
- package/assets/worker-configs/architect/.claude/skills/.gitkeep +0 -0
- package/assets/worker-configs/architect/CLAUDE.md +106 -0
- package/assets/worker-configs/clarifier/.claude/commands/.gitkeep +1 -0
- package/assets/worker-configs/clarifier/.claude/skills/.gitkeep +1 -0
- package/assets/worker-configs/clarifier/CLAUDE.md +112 -0
- package/assets/worker-configs/code-reviewer/CLAUDE.md +113 -0
- package/assets/worker-configs/consolidator/.claude/commands/.gitkeep +1 -0
- package/assets/worker-configs/consolidator/.claude/skills/.gitkeep +1 -0
- package/assets/worker-configs/consolidator/CLAUDE.md +114 -0
- package/assets/worker-configs/developer-backend/.claude/commands/.gitkeep +1 -0
- package/assets/worker-configs/developer-backend/.claude/skills/.gitkeep +1 -0
- package/assets/worker-configs/developer-backend/CLAUDE.md +116 -0
- package/assets/worker-configs/developer-frontend/.claude/commands/.gitkeep +1 -0
- package/assets/worker-configs/developer-frontend/.claude/skills/.gitkeep +1 -0
- package/assets/worker-configs/developer-frontend/CLAUDE.md +116 -0
- package/assets/worker-configs/developer-fullstack/.claude/commands/.gitkeep +1 -0
- package/assets/worker-configs/developer-fullstack/.claude/skills/.gitkeep +1 -0
- package/assets/worker-configs/developer-fullstack/CLAUDE.md +116 -0
- package/assets/worker-configs/devops-engineer/CLAUDE.md +111 -0
- package/assets/worker-configs/planner/.claude/commands/.gitkeep +1 -0
- package/assets/worker-configs/planner/.claude/skills/.gitkeep +1 -0
- package/assets/worker-configs/planner/CLAUDE.md +111 -0
- package/assets/worker-configs/product-owner/CLAUDE.md +108 -0
- package/assets/worker-configs/reviewer/.claude/commands/.gitkeep +1 -0
- package/assets/worker-configs/reviewer/.claude/skills/.gitkeep +1 -0
- package/assets/worker-configs/reviewer/CLAUDE.md +110 -0
- package/assets/worker-configs/security-engineer/CLAUDE.md +109 -0
- package/assets/worker-configs/spec-writer/.claude/commands/.gitkeep +1 -0
- package/assets/worker-configs/spec-writer/.claude/skills/.gitkeep +1 -0
- package/assets/worker-configs/spec-writer/CLAUDE.md +110 -0
- package/assets/worker-configs/technical-writer/CLAUDE.md +107 -0
- package/assets/worker-configs/tester/CLAUDE.md +110 -0
- package/dist/assets/claude-folder/agents/.gitkeep +0 -0
- package/dist/assets/claude-folder/commands/boss-commands.md +138 -0
- package/dist/assets/claude-folder/rules/boss-workflow.md +33 -0
- package/dist/assets/claude-folder/rules/code-style.md +23 -0
- package/dist/assets/claude-folder/rules/security.md +22 -0
- package/dist/assets/claude-folder/rules/testing.md +32 -0
- package/dist/assets/claude-folder/settings.local.json +88 -0
- package/dist/assets/claude-folder/skills/.gitkeep +0 -0
- package/dist/assets/claude-md/docs/container-use.md +140 -0
- package/dist/assets/claude-md/docs/github-operations.md +238 -0
- package/dist/assets/claude-md/docs/initialization.md +186 -0
- package/dist/assets/claude-md/docs/quality-standards.md +15 -0
- package/dist/assets/claude-md/docs/spec-kit.md +46 -0
- package/dist/assets/claude-md/docs/workers.md +174 -0
- package/dist/assets/claude-md/docs/workflow.md +140 -0
- package/dist/assets/claude-md/template.md +812 -0
- package/dist/assets/docker-compose/docker-compose.yml +52 -0
- package/dist/assets/git-hooks/commit-msg.sh +102 -0
- package/dist/assets/git-hooks/pre-commit-check.sh +21 -0
- package/dist/assets/git-hooks/pre-commit.sh +6 -0
- package/dist/assets/git-hooks/pre-push.sh +154 -0
- package/dist/assets/git-hooks/security-check.sh +40 -0
- package/dist/assets/git-hooks/test-changed.sh +84 -0
- package/dist/assets/github-workflows/CODEOWNERS +3 -0
- package/dist/assets/github-workflows/boss-ci.yml +40 -0
- package/dist/assets/github-workflows/boss-gates.yml +28 -0
- package/dist/assets/start-boss-sh/start-boss.sh +471 -0
- package/dist/assets/template-docs/api-service-fastify.md +98 -0
- package/dist/assets/template-docs/blank.md +91 -0
- package/dist/assets/template-docs/nextjs-app-turbo.md +102 -0
- package/dist/assets/template-docs/t3-app.md +106 -0
- package/dist/assets/template-loader/README.md +28 -0
- package/dist/assets/template-loader/eslint.config.node.js +28 -0
- package/dist/assets/template-loader/eslint.config.react.js +47 -0
- package/dist/assets/template-loader/gitignore +42 -0
- package/dist/assets/template-loader/index.test.ts +10 -0
- package/dist/assets/template-loader/index.ts +13 -0
- package/dist/assets/template-loader/prettierignore +8 -0
- package/dist/assets/template-loader/vitest.config.ts +19 -0
- package/dist/assets/worker-configs/architect/.claude/commands/.gitkeep +0 -0
- package/dist/assets/worker-configs/architect/.claude/skills/.gitkeep +0 -0
- package/dist/assets/worker-configs/architect/CLAUDE.md +106 -0
- package/dist/assets/worker-configs/clarifier/.claude/commands/.gitkeep +1 -0
- package/dist/assets/worker-configs/clarifier/.claude/skills/.gitkeep +1 -0
- package/dist/assets/worker-configs/clarifier/CLAUDE.md +112 -0
- package/dist/assets/worker-configs/code-reviewer/CLAUDE.md +113 -0
- package/dist/assets/worker-configs/consolidator/.claude/commands/.gitkeep +1 -0
- package/dist/assets/worker-configs/consolidator/.claude/skills/.gitkeep +1 -0
- package/dist/assets/worker-configs/consolidator/CLAUDE.md +114 -0
- package/dist/assets/worker-configs/developer-backend/.claude/commands/.gitkeep +1 -0
- package/dist/assets/worker-configs/developer-backend/.claude/skills/.gitkeep +1 -0
- package/dist/assets/worker-configs/developer-backend/CLAUDE.md +116 -0
- package/dist/assets/worker-configs/developer-frontend/.claude/commands/.gitkeep +1 -0
- package/dist/assets/worker-configs/developer-frontend/.claude/skills/.gitkeep +1 -0
- package/dist/assets/worker-configs/developer-frontend/CLAUDE.md +116 -0
- package/dist/assets/worker-configs/developer-fullstack/.claude/commands/.gitkeep +1 -0
- package/dist/assets/worker-configs/developer-fullstack/.claude/skills/.gitkeep +1 -0
- package/dist/assets/worker-configs/developer-fullstack/CLAUDE.md +116 -0
- package/dist/assets/worker-configs/devops-engineer/CLAUDE.md +111 -0
- package/dist/assets/worker-configs/planner/.claude/commands/.gitkeep +1 -0
- package/dist/assets/worker-configs/planner/.claude/skills/.gitkeep +1 -0
- package/dist/assets/worker-configs/planner/CLAUDE.md +111 -0
- package/dist/assets/worker-configs/product-owner/CLAUDE.md +108 -0
- package/dist/assets/worker-configs/reviewer/.claude/commands/.gitkeep +1 -0
- package/dist/assets/worker-configs/reviewer/.claude/skills/.gitkeep +1 -0
- package/dist/assets/worker-configs/reviewer/CLAUDE.md +110 -0
- package/dist/assets/worker-configs/security-engineer/CLAUDE.md +109 -0
- package/dist/assets/worker-configs/spec-writer/.claude/commands/.gitkeep +1 -0
- package/dist/assets/worker-configs/spec-writer/.claude/skills/.gitkeep +1 -0
- package/dist/assets/worker-configs/spec-writer/CLAUDE.md +110 -0
- package/dist/assets/worker-configs/technical-writer/CLAUDE.md +107 -0
- package/dist/assets/worker-configs/tester/CLAUDE.md +110 -0
- package/dist/commands/__tests__/bootstrap.test.d.ts +2 -0
- package/dist/commands/__tests__/bootstrap.test.d.ts.map +1 -0
- package/dist/commands/__tests__/bootstrap.test.js +379 -0
- package/dist/commands/__tests__/bootstrap.test.js.map +1 -0
- package/dist/commands/__tests__/doctor.test.d.ts +2 -0
- package/dist/commands/__tests__/doctor.test.d.ts.map +1 -0
- package/dist/commands/__tests__/doctor.test.js +13 -0
- package/dist/commands/__tests__/doctor.test.js.map +1 -0
- package/dist/commands/bootstrap.d.ts +3 -0
- package/dist/commands/bootstrap.d.ts.map +1 -0
- package/dist/commands/bootstrap.js +390 -0
- package/dist/commands/bootstrap.js.map +1 -0
- package/dist/commands/doctor.d.ts +2 -0
- package/dist/commands/doctor.d.ts.map +1 -0
- package/dist/commands/doctor.js +171 -0
- package/dist/commands/doctor.js.map +1 -0
- package/dist/commands/templates.d.ts +2 -0
- package/dist/commands/templates.d.ts.map +1 -0
- package/dist/commands/templates.js +12 -0
- package/dist/commands/templates.js.map +1 -0
- package/dist/constants.d.ts +23 -0
- package/dist/constants.d.ts.map +1 -0
- package/dist/constants.js +23 -0
- package/dist/constants.js.map +1 -0
- package/dist/generators/__tests__/boss-config.test.d.ts +2 -0
- package/dist/generators/__tests__/boss-config.test.d.ts.map +1 -0
- package/dist/generators/__tests__/boss-config.test.js +61 -0
- package/dist/generators/__tests__/boss-config.test.js.map +1 -0
- package/dist/generators/__tests__/claude-folder.test.d.ts +2 -0
- package/dist/generators/__tests__/claude-folder.test.d.ts.map +1 -0
- package/dist/generators/__tests__/claude-folder.test.js +128 -0
- package/dist/generators/__tests__/claude-folder.test.js.map +1 -0
- package/dist/generators/__tests__/claude-md.test.d.ts +2 -0
- package/dist/generators/__tests__/claude-md.test.d.ts.map +1 -0
- package/dist/generators/__tests__/claude-md.test.js +55 -0
- package/dist/generators/__tests__/claude-md.test.js.map +1 -0
- package/dist/generators/__tests__/container-use-config.test.d.ts +2 -0
- package/dist/generators/__tests__/container-use-config.test.d.ts.map +1 -0
- package/dist/generators/__tests__/container-use-config.test.js +80 -0
- package/dist/generators/__tests__/container-use-config.test.js.map +1 -0
- package/dist/generators/__tests__/docker-compose.test.d.ts +2 -0
- package/dist/generators/__tests__/docker-compose.test.d.ts.map +1 -0
- package/dist/generators/__tests__/docker-compose.test.js +39 -0
- package/dist/generators/__tests__/docker-compose.test.js.map +1 -0
- package/dist/generators/__tests__/git-hooks.test.d.ts +2 -0
- package/dist/generators/__tests__/git-hooks.test.d.ts.map +1 -0
- package/dist/generators/__tests__/git-hooks.test.js +118 -0
- package/dist/generators/__tests__/git-hooks.test.js.map +1 -0
- package/dist/generators/__tests__/github-workflows.test.d.ts +2 -0
- package/dist/generators/__tests__/github-workflows.test.d.ts.map +1 -0
- package/dist/generators/__tests__/github-workflows.test.js +86 -0
- package/dist/generators/__tests__/github-workflows.test.js.map +1 -0
- package/dist/generators/__tests__/mcp-config.test.d.ts +2 -0
- package/dist/generators/__tests__/mcp-config.test.d.ts.map +1 -0
- package/dist/generators/__tests__/mcp-config.test.js +131 -0
- package/dist/generators/__tests__/mcp-config.test.js.map +1 -0
- package/dist/generators/__tests__/project-structure.test.d.ts +2 -0
- package/dist/generators/__tests__/project-structure.test.d.ts.map +1 -0
- package/dist/generators/__tests__/project-structure.test.js +40 -0
- package/dist/generators/__tests__/project-structure.test.js.map +1 -0
- package/dist/generators/__tests__/quality-gates.test.d.ts +2 -0
- package/dist/generators/__tests__/quality-gates.test.d.ts.map +1 -0
- package/dist/generators/__tests__/quality-gates.test.js +71 -0
- package/dist/generators/__tests__/quality-gates.test.js.map +1 -0
- package/dist/generators/__tests__/specify-structure.test.d.ts +2 -0
- package/dist/generators/__tests__/specify-structure.test.d.ts.map +1 -0
- package/dist/generators/__tests__/specify-structure.test.js +63 -0
- package/dist/generators/__tests__/specify-structure.test.js.map +1 -0
- package/dist/generators/__tests__/start-boss-sh.test.d.ts +2 -0
- package/dist/generators/__tests__/start-boss-sh.test.d.ts.map +1 -0
- package/dist/generators/__tests__/start-boss-sh.test.js +36 -0
- package/dist/generators/__tests__/start-boss-sh.test.js.map +1 -0
- package/dist/generators/__tests__/template-docs.test.d.ts +2 -0
- package/dist/generators/__tests__/template-docs.test.d.ts.map +1 -0
- package/dist/generators/__tests__/template-docs.test.js +92 -0
- package/dist/generators/__tests__/template-docs.test.js.map +1 -0
- package/dist/generators/__tests__/template-loader.test.d.ts +2 -0
- package/dist/generators/__tests__/template-loader.test.d.ts.map +1 -0
- package/dist/generators/__tests__/template-loader.test.js +215 -0
- package/dist/generators/__tests__/template-loader.test.js.map +1 -0
- package/dist/generators/__tests__/worker-configs.test.d.ts +2 -0
- package/dist/generators/__tests__/worker-configs.test.d.ts.map +1 -0
- package/dist/generators/__tests__/worker-configs.test.js +122 -0
- package/dist/generators/__tests__/worker-configs.test.js.map +1 -0
- package/dist/generators/boss-config.d.ts +3 -0
- package/dist/generators/boss-config.d.ts.map +1 -0
- package/dist/generators/boss-config.js +242 -0
- package/dist/generators/boss-config.js.map +1 -0
- package/dist/generators/claude-folder.d.ts +3 -0
- package/dist/generators/claude-folder.d.ts.map +1 -0
- package/dist/generators/claude-folder.js +94 -0
- package/dist/generators/claude-folder.js.map +1 -0
- package/dist/generators/claude-md.d.ts +3 -0
- package/dist/generators/claude-md.d.ts.map +1 -0
- package/dist/generators/claude-md.js +64 -0
- package/dist/generators/claude-md.js.map +1 -0
- package/dist/generators/container-use-config.d.ts +13 -0
- package/dist/generators/container-use-config.d.ts.map +1 -0
- package/dist/generators/container-use-config.js +60 -0
- package/dist/generators/container-use-config.js.map +1 -0
- package/dist/generators/docker-compose.d.ts +2 -0
- package/dist/generators/docker-compose.d.ts.map +1 -0
- package/dist/generators/docker-compose.js +8 -0
- package/dist/generators/docker-compose.js.map +1 -0
- package/dist/generators/git-hooks.d.ts +3 -0
- package/dist/generators/git-hooks.d.ts.map +1 -0
- package/dist/generators/git-hooks.js +58 -0
- package/dist/generators/git-hooks.js.map +1 -0
- package/dist/generators/github-workflows.d.ts +3 -0
- package/dist/generators/github-workflows.d.ts.map +1 -0
- package/dist/generators/github-workflows.js +27 -0
- package/dist/generators/github-workflows.js.map +1 -0
- package/dist/generators/mcp-config.d.ts +3 -0
- package/dist/generators/mcp-config.d.ts.map +1 -0
- package/dist/generators/mcp-config.js +183 -0
- package/dist/generators/mcp-config.js.map +1 -0
- package/dist/generators/project-structure.d.ts +3 -0
- package/dist/generators/project-structure.d.ts.map +1 -0
- package/dist/generators/project-structure.js +24 -0
- package/dist/generators/project-structure.js.map +1 -0
- package/dist/generators/quality-gates.d.ts +3 -0
- package/dist/generators/quality-gates.d.ts.map +1 -0
- package/dist/generators/quality-gates.js +32 -0
- package/dist/generators/quality-gates.js.map +1 -0
- package/dist/generators/specify-structure.d.ts +2 -0
- package/dist/generators/specify-structure.d.ts.map +1 -0
- package/dist/generators/specify-structure.js +43 -0
- package/dist/generators/specify-structure.js.map +1 -0
- package/dist/generators/start-boss-sh.d.ts +2 -0
- package/dist/generators/start-boss-sh.d.ts.map +1 -0
- package/dist/generators/start-boss-sh.js +10 -0
- package/dist/generators/start-boss-sh.js.map +1 -0
- package/dist/generators/template-docs.d.ts +3 -0
- package/dist/generators/template-docs.d.ts.map +1 -0
- package/dist/generators/template-docs.js +19 -0
- package/dist/generators/template-docs.js.map +1 -0
- package/dist/generators/template-loader.d.ts +3 -0
- package/dist/generators/template-loader.d.ts.map +1 -0
- package/dist/generators/template-loader.js +308 -0
- package/dist/generators/template-loader.js.map +1 -0
- package/dist/generators/worker-configs.d.ts +3 -0
- package/dist/generators/worker-configs.d.ts.map +1 -0
- package/dist/generators/worker-configs.js +119 -0
- package/dist/generators/worker-configs.js.map +1 -0
- package/dist/index.d.ts +3 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +57 -0
- package/dist/index.js.map +1 -0
- package/dist/presets/__tests__/quality-presets.test.d.ts +2 -0
- package/dist/presets/__tests__/quality-presets.test.d.ts.map +1 -0
- package/dist/presets/__tests__/quality-presets.test.js +152 -0
- package/dist/presets/__tests__/quality-presets.test.js.map +1 -0
- package/dist/presets/quality-presets.d.ts +3 -0
- package/dist/presets/quality-presets.d.ts.map +1 -0
- package/dist/presets/quality-presets.js +65 -0
- package/dist/presets/quality-presets.js.map +1 -0
- package/dist/types/index.d.ts +42 -0
- package/dist/types/index.d.ts.map +1 -0
- package/dist/types/index.js +2 -0
- package/dist/types/index.js.map +1 -0
- package/dist/utils/__tests__/file-system.test.d.ts +2 -0
- package/dist/utils/__tests__/file-system.test.d.ts.map +1 -0
- package/dist/utils/__tests__/file-system.test.js +83 -0
- package/dist/utils/__tests__/file-system.test.js.map +1 -0
- package/dist/utils/__tests__/git.test.d.ts +2 -0
- package/dist/utils/__tests__/git.test.d.ts.map +1 -0
- package/dist/utils/__tests__/git.test.js +79 -0
- package/dist/utils/__tests__/git.test.js.map +1 -0
- package/dist/utils/__tests__/template-loader.test.d.ts +2 -0
- package/dist/utils/__tests__/template-loader.test.d.ts.map +1 -0
- package/dist/utils/__tests__/template-loader.test.js +109 -0
- package/dist/utils/__tests__/template-loader.test.js.map +1 -0
- package/dist/utils/__tests__/validators.test.d.ts +2 -0
- package/dist/utils/__tests__/validators.test.d.ts.map +1 -0
- package/dist/utils/__tests__/validators.test.js +118 -0
- package/dist/utils/__tests__/validators.test.js.map +1 -0
- package/dist/utils/file-system.d.ts +8 -0
- package/dist/utils/file-system.d.ts.map +1 -0
- package/dist/utils/file-system.js +54 -0
- package/dist/utils/file-system.js.map +1 -0
- package/dist/utils/git.d.ts +7 -0
- package/dist/utils/git.d.ts.map +1 -0
- package/dist/utils/git.js +98 -0
- package/dist/utils/git.js.map +1 -0
- package/dist/utils/logger.d.ts +13 -0
- package/dist/utils/logger.d.ts.map +1 -0
- package/dist/utils/logger.js +42 -0
- package/dist/utils/logger.js.map +1 -0
- package/dist/utils/prompts.d.ts +18 -0
- package/dist/utils/prompts.d.ts.map +1 -0
- package/dist/utils/prompts.js +197 -0
- package/dist/utils/prompts.js.map +1 -0
- package/dist/utils/template-loader.d.ts +18 -0
- package/dist/utils/template-loader.d.ts.map +1 -0
- package/dist/utils/template-loader.js +92 -0
- package/dist/utils/template-loader.js.map +1 -0
- package/dist/utils/validators.d.ts +21 -0
- package/dist/utils/validators.d.ts.map +1 -0
- package/dist/utils/validators.js +50 -0
- package/dist/utils/validators.js.map +1 -0
- package/package.json +79 -0
- package/templates/spec-kit/README.md +17 -0
- package/templates/spec-kit/memory/constitution.md +50 -0
- package/templates/spec-kit/scripts/bash/check-prerequisites.sh +166 -0
- package/templates/spec-kit/scripts/bash/common.sh +156 -0
- package/templates/spec-kit/scripts/bash/create-new-feature.sh +297 -0
- package/templates/spec-kit/scripts/bash/setup-plan.sh +61 -0
- package/templates/spec-kit/scripts/bash/update-agent-context.sh +799 -0
- package/templates/spec-kit/scripts/powershell/check-prerequisites.ps1 +148 -0
- package/templates/spec-kit/scripts/powershell/common.ps1 +137 -0
- package/templates/spec-kit/scripts/powershell/create-new-feature.ps1 +283 -0
- package/templates/spec-kit/scripts/powershell/setup-plan.ps1 +61 -0
- package/templates/spec-kit/scripts/powershell/update-agent-context.ps1 +448 -0
- package/templates/spec-kit/src/specify_cli/__init__.py +1369 -0
- package/templates/spec-kit/templates/agent-file-template.md +28 -0
- package/templates/spec-kit/templates/checklist-template.md +40 -0
- package/templates/spec-kit/templates/commands/analyze.md +187 -0
- package/templates/spec-kit/templates/commands/checklist.md +297 -0
- package/templates/spec-kit/templates/commands/clarify.md +184 -0
- package/templates/spec-kit/templates/commands/constitution.md +82 -0
- package/templates/spec-kit/templates/commands/implement.md +138 -0
- package/templates/spec-kit/templates/commands/plan.md +95 -0
- package/templates/spec-kit/templates/commands/specify.md +261 -0
- package/templates/spec-kit/templates/commands/tasks.md +140 -0
- package/templates/spec-kit/templates/commands/taskstoissues.md +33 -0
- package/templates/spec-kit/templates/plan-template.md +104 -0
- package/templates/spec-kit/templates/spec-template.md +115 -0
- package/templates/spec-kit/templates/tasks-template.md +251 -0
- package/templates/spec-kit/templates/vscode-settings.json +14 -0
- package/templates/t3-app/README.md +41 -0
- package/templates/t3-app/base/README.md +29 -0
- package/templates/t3-app/base/_gitignore +47 -0
- package/templates/t3-app/base/next-env.d.ts +5 -0
- package/templates/t3-app/base/next.config.js +22 -0
- package/templates/t3-app/base/package.json +26 -0
- package/templates/t3-app/base/public/favicon.ico +0 -0
- package/templates/t3-app/base/src/env.js +40 -0
- package/templates/t3-app/base/src/styles/globals.css +16 -0
- package/templates/t3-app/base/tsconfig.json +42 -0
- package/templates/t3-app/extras/config/_eslint.base.js +45 -0
- package/templates/t3-app/extras/config/_eslint.drizzle.js +58 -0
- package/templates/t3-app/extras/config/_prettier.config.js +2 -0
- package/templates/t3-app/extras/config/_tailwind.prettier.config.js +4 -0
- package/templates/t3-app/extras/config/biome.jsonc +69 -0
- package/templates/t3-app/extras/config/drizzle-config-mysql.ts +12 -0
- package/templates/t3-app/extras/config/drizzle-config-postgres.ts +12 -0
- package/templates/t3-app/extras/config/drizzle-config-sqlite.ts +12 -0
- package/templates/t3-app/extras/config/next-config-appdir.js +10 -0
- package/templates/t3-app/extras/config/postcss.config.js +5 -0
- package/templates/t3-app/extras/pnpm/_npmrc +2 -0
- package/templates/t3-app/extras/prisma/schema/base-planetscale.prisma +25 -0
- package/templates/t3-app/extras/prisma/schema/base.prisma +21 -0
- package/templates/t3-app/extras/prisma/schema/with-auth-planetscale.prisma +79 -0
- package/templates/t3-app/extras/prisma/schema/with-auth.prisma +75 -0
- package/templates/t3-app/extras/prisma/schema/with-better-auth-planetscale.prisma +90 -0
- package/templates/t3-app/extras/prisma/schema/with-better-auth.prisma +89 -0
- package/templates/t3-app/extras/src/app/_components/post-tw.tsx +50 -0
- package/templates/t3-app/extras/src/app/_components/post.tsx +54 -0
- package/templates/t3-app/extras/src/app/api/auth/[...all]/route.ts +5 -0
- package/templates/t3-app/extras/src/app/api/auth/[...nextauth]/route.ts +3 -0
- package/templates/t3-app/extras/src/app/api/trpc/[trpc]/route.ts +34 -0
- package/templates/t3-app/extras/src/app/layout/base.tsx +24 -0
- package/templates/t3-app/extras/src/app/layout/with-trpc-tw.tsx +29 -0
- package/templates/t3-app/extras/src/app/layout/with-trpc.tsx +28 -0
- package/templates/t3-app/extras/src/app/layout/with-tw.tsx +25 -0
- package/templates/t3-app/extras/src/app/page/base.tsx +39 -0
- package/templates/t3-app/extras/src/app/page/with-auth-trpc-tw.tsx +69 -0
- package/templates/t3-app/extras/src/app/page/with-auth-trpc.tsx +70 -0
- package/templates/t3-app/extras/src/app/page/with-better-auth-trpc-tw.tsx +105 -0
- package/templates/t3-app/extras/src/app/page/with-better-auth-trpc.tsx +103 -0
- package/templates/t3-app/extras/src/app/page/with-better-auth-tw.tsx +90 -0
- package/templates/t3-app/extras/src/app/page/with-better-auth.tsx +88 -0
- package/templates/t3-app/extras/src/app/page/with-trpc-tw.tsx +53 -0
- package/templates/t3-app/extras/src/app/page/with-trpc.tsx +54 -0
- package/templates/t3-app/extras/src/app/page/with-tw.tsx +37 -0
- package/templates/t3-app/extras/src/env/with-auth-db-planetscale.js +58 -0
- package/templates/t3-app/extras/src/env/with-auth-db.js +52 -0
- package/templates/t3-app/extras/src/env/with-auth.js +51 -0
- package/templates/t3-app/extras/src/env/with-better-auth-db-planetscale.js +58 -0
- package/templates/t3-app/extras/src/env/with-better-auth-db.js +50 -0
- package/templates/t3-app/extras/src/env/with-better-auth.js +49 -0
- package/templates/t3-app/extras/src/env/with-db-planetscale.js +50 -0
- package/templates/t3-app/extras/src/env/with-db.js +44 -0
- package/templates/t3-app/extras/src/index.module.css +177 -0
- package/templates/t3-app/extras/src/pages/_app/base.tsx +18 -0
- package/templates/t3-app/extras/src/pages/_app/with-auth-trpc-tw.tsx +27 -0
- package/templates/t3-app/extras/src/pages/_app/with-auth-trpc.tsx +27 -0
- package/templates/t3-app/extras/src/pages/_app/with-auth-tw.tsx +25 -0
- package/templates/t3-app/extras/src/pages/_app/with-auth.tsx +25 -0
- package/templates/t3-app/extras/src/pages/_app/with-better-auth-trpc-tw.tsx +20 -0
- package/templates/t3-app/extras/src/pages/_app/with-better-auth-trpc.tsx +20 -0
- package/templates/t3-app/extras/src/pages/_app/with-trpc-tw.tsx +20 -0
- package/templates/t3-app/extras/src/pages/_app/with-trpc.tsx +20 -0
- package/templates/t3-app/extras/src/pages/_app/with-tw.tsx +18 -0
- package/templates/t3-app/extras/src/pages/api/auth/[...all].ts +8 -0
- package/templates/t3-app/extras/src/pages/api/trpc/[trpc].ts +19 -0
- package/templates/t3-app/extras/src/pages/index/base.tsx +47 -0
- package/templates/t3-app/extras/src/pages/index/with-auth-trpc-tw.tsx +81 -0
- package/templates/t3-app/extras/src/pages/index/with-auth-trpc.tsx +82 -0
- package/templates/t3-app/extras/src/pages/index/with-better-auth-trpc-tw.tsx +99 -0
- package/templates/t3-app/extras/src/pages/index/with-better-auth-trpc.tsx +100 -0
- package/templates/t3-app/extras/src/pages/index/with-better-auth-tw.tsx +87 -0
- package/templates/t3-app/extras/src/pages/index/with-better-auth.tsx +88 -0
- package/templates/t3-app/extras/src/pages/index/with-trpc-tw.tsx +52 -0
- package/templates/t3-app/extras/src/pages/index/with-trpc.tsx +53 -0
- package/templates/t3-app/extras/src/pages/index/with-tw.tsx +45 -0
- package/templates/t3-app/extras/src/server/api/root.ts +23 -0
- package/templates/t3-app/extras/src/server/api/routers/post/base.ts +40 -0
- package/templates/t3-app/extras/src/server/api/routers/post/with-auth-drizzle.ts +39 -0
- package/templates/t3-app/extras/src/server/api/routers/post/with-auth-prisma.ts +41 -0
- package/templates/t3-app/extras/src/server/api/routers/post/with-auth.ts +37 -0
- package/templates/t3-app/extras/src/server/api/routers/post/with-drizzle.ts +30 -0
- package/templates/t3-app/extras/src/server/api/routers/post/with-prisma.ts +31 -0
- package/templates/t3-app/extras/src/server/api/trpc-app/base.ts +103 -0
- package/templates/t3-app/extras/src/server/api/trpc-app/with-auth-db.ts +133 -0
- package/templates/t3-app/extras/src/server/api/trpc-app/with-auth.ts +130 -0
- package/templates/t3-app/extras/src/server/api/trpc-app/with-better-auth-db.ts +134 -0
- package/templates/t3-app/extras/src/server/api/trpc-app/with-better-auth.ts +131 -0
- package/templates/t3-app/extras/src/server/api/trpc-app/with-db.ts +106 -0
- package/templates/t3-app/extras/src/server/api/trpc-pages/base.ts +122 -0
- package/templates/t3-app/extras/src/server/api/trpc-pages/with-auth-db.ts +160 -0
- package/templates/t3-app/extras/src/server/api/trpc-pages/with-auth.ts +158 -0
- package/templates/t3-app/extras/src/server/api/trpc-pages/with-better-auth-db.ts +168 -0
- package/templates/t3-app/extras/src/server/api/trpc-pages/with-better-auth.ts +166 -0
- package/templates/t3-app/extras/src/server/api/trpc-pages/with-db.ts +125 -0
- package/templates/t3-app/extras/src/server/auth/config/base.ts +52 -0
- package/templates/t3-app/extras/src/server/auth/config/with-drizzle.ts +67 -0
- package/templates/t3-app/extras/src/server/auth/config/with-prisma.ts +56 -0
- package/templates/t3-app/extras/src/server/auth/index.ts +10 -0
- package/templates/t3-app/extras/src/server/better-auth/client.ts +5 -0
- package/templates/t3-app/extras/src/server/better-auth/config/base.ts +12 -0
- package/templates/t3-app/extras/src/server/better-auth/config/with-drizzle.ts +26 -0
- package/templates/t3-app/extras/src/server/better-auth/config/with-prisma.ts +26 -0
- package/templates/t3-app/extras/src/server/better-auth/index.ts +1 -0
- package/templates/t3-app/extras/src/server/better-auth/server.ts +7 -0
- package/templates/t3-app/extras/src/server/db/db-prisma-planetscale.ts +19 -0
- package/templates/t3-app/extras/src/server/db/db-prisma.ts +16 -0
- package/templates/t3-app/extras/src/server/db/index-drizzle/with-mysql.ts +18 -0
- package/templates/t3-app/extras/src/server/db/index-drizzle/with-planetscale.ts +7 -0
- package/templates/t3-app/extras/src/server/db/index-drizzle/with-postgres.ts +18 -0
- package/templates/t3-app/extras/src/server/db/index-drizzle/with-sqlite.ts +19 -0
- package/templates/t3-app/extras/src/server/db/schema-drizzle/base-mysql.ts +26 -0
- package/templates/t3-app/extras/src/server/db/schema-drizzle/base-planetscale.ts +26 -0
- package/templates/t3-app/extras/src/server/db/schema-drizzle/base-postgres.ts +26 -0
- package/templates/t3-app/extras/src/server/db/schema-drizzle/base-sqlite.ts +27 -0
- package/templates/t3-app/extras/src/server/db/schema-drizzle/with-auth-mysql.ts +111 -0
- package/templates/t3-app/extras/src/server/db/schema-drizzle/with-auth-planetscale.ts +100 -0
- package/templates/t3-app/extras/src/server/db/schema-drizzle/with-auth-postgres.ts +108 -0
- package/templates/t3-app/extras/src/server/db/schema-drizzle/with-auth-sqlite.ts +105 -0
- package/templates/t3-app/extras/src/server/db/schema-drizzle/with-better-auth-mysql.ts +106 -0
- package/templates/t3-app/extras/src/server/db/schema-drizzle/with-better-auth-planetscale.ts +106 -0
- package/templates/t3-app/extras/src/server/db/schema-drizzle/with-better-auth-postgres.ts +105 -0
- package/templates/t3-app/extras/src/server/db/schema-drizzle/with-better-auth-sqlite.ts +134 -0
- package/templates/t3-app/extras/src/styles/globals.css +6 -0
- package/templates/t3-app/extras/src/trpc/query-client.ts +25 -0
- package/templates/t3-app/extras/src/trpc/react.tsx +78 -0
- package/templates/t3-app/extras/src/trpc/server.ts +30 -0
- package/templates/t3-app/extras/src/utils/api.ts +68 -0
- package/templates/t3-app/extras/start-database/mysql.sh +86 -0
- package/templates/t3-app/extras/start-database/postgres.sh +88 -0
|
@@ -0,0 +1,261 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Create or update the feature specification from a natural language feature description.
|
|
3
|
+
handoffs:
|
|
4
|
+
- label: Build Technical Plan
|
|
5
|
+
agent: speckit.plan
|
|
6
|
+
prompt: Create a plan for the spec. I am building with...
|
|
7
|
+
- label: Clarify Spec Requirements
|
|
8
|
+
agent: speckit.clarify
|
|
9
|
+
prompt: Clarify specification requirements
|
|
10
|
+
send: true
|
|
11
|
+
scripts:
|
|
12
|
+
sh: scripts/bash/create-new-feature.sh --json "{ARGS}"
|
|
13
|
+
ps: scripts/powershell/create-new-feature.ps1 -Json "{ARGS}"
|
|
14
|
+
---
|
|
15
|
+
|
|
16
|
+
## User Input
|
|
17
|
+
|
|
18
|
+
```text
|
|
19
|
+
$ARGUMENTS
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
You **MUST** consider the user input before proceeding (if not empty).
|
|
23
|
+
|
|
24
|
+
## Outline
|
|
25
|
+
|
|
26
|
+
The text the user typed after `/speckit.specify` in the triggering message **is** the feature description. Assume you always have it available in this conversation even if `{ARGS}` appears literally below. Do not ask the user to repeat it unless they provided an empty command.
|
|
27
|
+
|
|
28
|
+
Given that feature description, do this:
|
|
29
|
+
|
|
30
|
+
1. **Generate a concise short name** (2-4 words) for the branch:
|
|
31
|
+
- Analyze the feature description and extract the most meaningful keywords
|
|
32
|
+
- Create a 2-4 word short name that captures the essence of the feature
|
|
33
|
+
- Use action-noun format when possible (e.g., "add-user-auth", "fix-payment-bug")
|
|
34
|
+
- Preserve technical terms and acronyms (OAuth2, API, JWT, etc.)
|
|
35
|
+
- Keep it concise but descriptive enough to understand the feature at a glance
|
|
36
|
+
- Examples:
|
|
37
|
+
- "I want to add user authentication" → "user-auth"
|
|
38
|
+
- "Implement OAuth2 integration for the API" → "oauth2-api-integration"
|
|
39
|
+
- "Create a dashboard for analytics" → "analytics-dashboard"
|
|
40
|
+
- "Fix payment processing timeout bug" → "fix-payment-timeout"
|
|
41
|
+
|
|
42
|
+
2. **Check for existing branches before creating new one**:
|
|
43
|
+
|
|
44
|
+
a. First, fetch all remote branches to ensure we have the latest information:
|
|
45
|
+
|
|
46
|
+
```bash
|
|
47
|
+
git fetch --all --prune
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
b. Find the highest feature number across all sources for the short-name:
|
|
51
|
+
- Remote branches: `git ls-remote --heads origin | grep -E 'refs/heads/[0-9]+-<short-name>$'`
|
|
52
|
+
- Local branches: `git branch | grep -E '^[* ]*[0-9]+-<short-name>$'`
|
|
53
|
+
- Specs directories: Check for directories matching `specs/[0-9]+-<short-name>`
|
|
54
|
+
|
|
55
|
+
c. Determine the next available number:
|
|
56
|
+
- Extract all numbers from all three sources
|
|
57
|
+
- Find the highest number N
|
|
58
|
+
- Use N+1 for the new branch number
|
|
59
|
+
|
|
60
|
+
d. Run the script `{SCRIPT}` with the calculated number and short-name:
|
|
61
|
+
- Pass `--number N+1` and `--short-name "your-short-name"` along with the feature description
|
|
62
|
+
- Bash example: `{SCRIPT} --json --number 5 --short-name "user-auth" "Add user authentication"`
|
|
63
|
+
- PowerShell example: `{SCRIPT} -Json -Number 5 -ShortName "user-auth" "Add user authentication"`
|
|
64
|
+
|
|
65
|
+
**IMPORTANT**:
|
|
66
|
+
- Check all three sources (remote branches, local branches, specs directories) to find the highest number
|
|
67
|
+
- Only match branches/directories with the exact short-name pattern
|
|
68
|
+
- If no existing branches/directories found with this short-name, start with number 1
|
|
69
|
+
- You must only ever run this script once per feature
|
|
70
|
+
- The JSON is provided in the terminal as output - always refer to it to get the actual content you're looking for
|
|
71
|
+
- The JSON output will contain BRANCH_NAME and SPEC_FILE paths
|
|
72
|
+
- For single quotes in args like "I'm Groot", use escape syntax: e.g 'I'\''m Groot' (or double-quote if possible: "I'm Groot")
|
|
73
|
+
|
|
74
|
+
3. Load `templates/spec-template.md` to understand required sections.
|
|
75
|
+
|
|
76
|
+
4. Follow this execution flow:
|
|
77
|
+
|
|
78
|
+
1. Parse user description from Input
|
|
79
|
+
If empty: ERROR "No feature description provided"
|
|
80
|
+
2. Extract key concepts from description
|
|
81
|
+
Identify: actors, actions, data, constraints
|
|
82
|
+
3. For unclear aspects:
|
|
83
|
+
- Make informed guesses based on context and industry standards
|
|
84
|
+
- Only mark with [NEEDS CLARIFICATION: specific question] if:
|
|
85
|
+
- The choice significantly impacts feature scope or user experience
|
|
86
|
+
- Multiple reasonable interpretations exist with different implications
|
|
87
|
+
- No reasonable default exists
|
|
88
|
+
- **LIMIT: Maximum 3 [NEEDS CLARIFICATION] markers total**
|
|
89
|
+
- Prioritize clarifications by impact: scope > security/privacy > user experience > technical details
|
|
90
|
+
4. Fill User Scenarios & Testing section
|
|
91
|
+
If no clear user flow: ERROR "Cannot determine user scenarios"
|
|
92
|
+
5. Generate Functional Requirements
|
|
93
|
+
Each requirement must be testable
|
|
94
|
+
Use reasonable defaults for unspecified details (document assumptions in Assumptions section)
|
|
95
|
+
6. Define Success Criteria
|
|
96
|
+
Create measurable, technology-agnostic outcomes
|
|
97
|
+
Include both quantitative metrics (time, performance, volume) and qualitative measures (user satisfaction, task completion)
|
|
98
|
+
Each criterion must be verifiable without implementation details
|
|
99
|
+
7. Identify Key Entities (if data involved)
|
|
100
|
+
8. Return: SUCCESS (spec ready for planning)
|
|
101
|
+
|
|
102
|
+
5. Write the specification to SPEC_FILE using the template structure, replacing placeholders with concrete details derived from the feature description (arguments) while preserving section order and headings.
|
|
103
|
+
|
|
104
|
+
6. **Specification Quality Validation**: After writing the initial spec, validate it against quality criteria:
|
|
105
|
+
|
|
106
|
+
a. **Create Spec Quality Checklist**: Generate a checklist file at `FEATURE_DIR/checklists/requirements.md` using the checklist template structure with these validation items:
|
|
107
|
+
|
|
108
|
+
```markdown
|
|
109
|
+
# Specification Quality Checklist: [FEATURE NAME]
|
|
110
|
+
|
|
111
|
+
**Purpose**: Validate specification completeness and quality before proceeding to planning
|
|
112
|
+
**Created**: [DATE]
|
|
113
|
+
**Feature**: [Link to spec.md]
|
|
114
|
+
|
|
115
|
+
## Content Quality
|
|
116
|
+
|
|
117
|
+
- [ ] No implementation details (languages, frameworks, APIs)
|
|
118
|
+
- [ ] Focused on user value and business needs
|
|
119
|
+
- [ ] Written for non-technical stakeholders
|
|
120
|
+
- [ ] All mandatory sections completed
|
|
121
|
+
|
|
122
|
+
## Requirement Completeness
|
|
123
|
+
|
|
124
|
+
- [ ] No [NEEDS CLARIFICATION] markers remain
|
|
125
|
+
- [ ] Requirements are testable and unambiguous
|
|
126
|
+
- [ ] Success criteria are measurable
|
|
127
|
+
- [ ] Success criteria are technology-agnostic (no implementation details)
|
|
128
|
+
- [ ] All acceptance scenarios are defined
|
|
129
|
+
- [ ] Edge cases are identified
|
|
130
|
+
- [ ] Scope is clearly bounded
|
|
131
|
+
- [ ] Dependencies and assumptions identified
|
|
132
|
+
|
|
133
|
+
## Feature Readiness
|
|
134
|
+
|
|
135
|
+
- [ ] All functional requirements have clear acceptance criteria
|
|
136
|
+
- [ ] User scenarios cover primary flows
|
|
137
|
+
- [ ] Feature meets measurable outcomes defined in Success Criteria
|
|
138
|
+
- [ ] No implementation details leak into specification
|
|
139
|
+
|
|
140
|
+
## Notes
|
|
141
|
+
|
|
142
|
+
- Items marked incomplete require spec updates before `/speckit.clarify` or `/speckit.plan`
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
b. **Run Validation Check**: Review the spec against each checklist item:
|
|
146
|
+
- For each item, determine if it passes or fails
|
|
147
|
+
- Document specific issues found (quote relevant spec sections)
|
|
148
|
+
|
|
149
|
+
c. **Handle Validation Results**:
|
|
150
|
+
|
|
151
|
+
- **If all items pass**: Mark checklist complete and proceed to step 6
|
|
152
|
+
|
|
153
|
+
- **If items fail (excluding [NEEDS CLARIFICATION])**:
|
|
154
|
+
1. List the failing items and specific issues
|
|
155
|
+
2. Update the spec to address each issue
|
|
156
|
+
3. Re-run validation until all items pass (max 3 iterations)
|
|
157
|
+
4. If still failing after 3 iterations, document remaining issues in checklist notes and warn user
|
|
158
|
+
|
|
159
|
+
- **If [NEEDS CLARIFICATION] markers remain**:
|
|
160
|
+
1. Extract all [NEEDS CLARIFICATION: ...] markers from the spec
|
|
161
|
+
2. **LIMIT CHECK**: If more than 3 markers exist, keep only the 3 most critical (by scope/security/UX impact) and make informed guesses for the rest
|
|
162
|
+
3. For each clarification needed (max 3), present options to user in this format:
|
|
163
|
+
|
|
164
|
+
```markdown
|
|
165
|
+
## Question [N]: [Topic]
|
|
166
|
+
|
|
167
|
+
**Context**: [Quote relevant spec section]
|
|
168
|
+
|
|
169
|
+
**What we need to know**: [Specific question from NEEDS CLARIFICATION marker]
|
|
170
|
+
|
|
171
|
+
**Suggested Answers**:
|
|
172
|
+
|
|
173
|
+
| Option | Answer | Implications |
|
|
174
|
+
|--------|--------|--------------|
|
|
175
|
+
| A | [First suggested answer] | [What this means for the feature] |
|
|
176
|
+
| B | [Second suggested answer] | [What this means for the feature] |
|
|
177
|
+
| C | [Third suggested answer] | [What this means for the feature] |
|
|
178
|
+
| Custom | Provide your own answer | [Explain how to provide custom input] |
|
|
179
|
+
|
|
180
|
+
**Your choice**: _[Wait for user response]_
|
|
181
|
+
```
|
|
182
|
+
|
|
183
|
+
4. **CRITICAL - Table Formatting**: Ensure markdown tables are properly formatted:
|
|
184
|
+
- Use consistent spacing with pipes aligned
|
|
185
|
+
- Each cell should have spaces around content: `| Content |` not `|Content|`
|
|
186
|
+
- Header separator must have at least 3 dashes: `|--------|`
|
|
187
|
+
- Test that the table renders correctly in markdown preview
|
|
188
|
+
5. Number questions sequentially (Q1, Q2, Q3 - max 3 total)
|
|
189
|
+
6. Present all questions together before waiting for responses
|
|
190
|
+
7. Wait for user to respond with their choices for all questions (e.g., "Q1: A, Q2: Custom - [details], Q3: B")
|
|
191
|
+
8. Update the spec by replacing each [NEEDS CLARIFICATION] marker with the user's selected or provided answer
|
|
192
|
+
9. Re-run validation after all clarifications are resolved
|
|
193
|
+
|
|
194
|
+
d. **Update Checklist**: After each validation iteration, update the checklist file with current pass/fail status
|
|
195
|
+
|
|
196
|
+
7. Report completion with branch name, spec file path, checklist results, and readiness for the next phase (`/speckit.clarify` or `/speckit.plan`).
|
|
197
|
+
|
|
198
|
+
**NOTE:** The script creates and checks out the new branch and initializes the spec file before writing.
|
|
199
|
+
|
|
200
|
+
## General Guidelines
|
|
201
|
+
|
|
202
|
+
## Quick Guidelines
|
|
203
|
+
|
|
204
|
+
- Focus on **WHAT** users need and **WHY**.
|
|
205
|
+
- Avoid HOW to implement (no tech stack, APIs, code structure).
|
|
206
|
+
- Written for business stakeholders, not developers.
|
|
207
|
+
- DO NOT create any checklists that are embedded in the spec. That will be a separate command.
|
|
208
|
+
|
|
209
|
+
### Section Requirements
|
|
210
|
+
|
|
211
|
+
- **Mandatory sections**: Must be completed for every feature
|
|
212
|
+
- **Optional sections**: Include only when relevant to the feature
|
|
213
|
+
- When a section doesn't apply, remove it entirely (don't leave as "N/A")
|
|
214
|
+
|
|
215
|
+
### For AI Generation
|
|
216
|
+
|
|
217
|
+
When creating this spec from a user prompt:
|
|
218
|
+
|
|
219
|
+
1. **Make informed guesses**: Use context, industry standards, and common patterns to fill gaps
|
|
220
|
+
2. **Document assumptions**: Record reasonable defaults in the Assumptions section
|
|
221
|
+
3. **Limit clarifications**: Maximum 3 [NEEDS CLARIFICATION] markers - use only for critical decisions that:
|
|
222
|
+
- Significantly impact feature scope or user experience
|
|
223
|
+
- Have multiple reasonable interpretations with different implications
|
|
224
|
+
- Lack any reasonable default
|
|
225
|
+
4. **Prioritize clarifications**: scope > security/privacy > user experience > technical details
|
|
226
|
+
5. **Think like a tester**: Every vague requirement should fail the "testable and unambiguous" checklist item
|
|
227
|
+
6. **Common areas needing clarification** (only if no reasonable default exists):
|
|
228
|
+
- Feature scope and boundaries (include/exclude specific use cases)
|
|
229
|
+
- User types and permissions (if multiple conflicting interpretations possible)
|
|
230
|
+
- Security/compliance requirements (when legally/financially significant)
|
|
231
|
+
|
|
232
|
+
**Examples of reasonable defaults** (don't ask about these):
|
|
233
|
+
|
|
234
|
+
- Data retention: Industry-standard practices for the domain
|
|
235
|
+
- Performance targets: Standard web/mobile app expectations unless specified
|
|
236
|
+
- Error handling: User-friendly messages with appropriate fallbacks
|
|
237
|
+
- Authentication method: Standard session-based or OAuth2 for web apps
|
|
238
|
+
- Integration patterns: RESTful APIs unless specified otherwise
|
|
239
|
+
|
|
240
|
+
### Success Criteria Guidelines
|
|
241
|
+
|
|
242
|
+
Success criteria must be:
|
|
243
|
+
|
|
244
|
+
1. **Measurable**: Include specific metrics (time, percentage, count, rate)
|
|
245
|
+
2. **Technology-agnostic**: No mention of frameworks, languages, databases, or tools
|
|
246
|
+
3. **User-focused**: Describe outcomes from user/business perspective, not system internals
|
|
247
|
+
4. **Verifiable**: Can be tested/validated without knowing implementation details
|
|
248
|
+
|
|
249
|
+
**Good examples**:
|
|
250
|
+
|
|
251
|
+
- "Users can complete checkout in under 3 minutes"
|
|
252
|
+
- "System supports 10,000 concurrent users"
|
|
253
|
+
- "95% of searches return results in under 1 second"
|
|
254
|
+
- "Task completion rate improves by 40%"
|
|
255
|
+
|
|
256
|
+
**Bad examples** (implementation-focused):
|
|
257
|
+
|
|
258
|
+
- "API response time is under 200ms" (too technical, use "Users see results instantly")
|
|
259
|
+
- "Database can handle 1000 TPS" (implementation detail, use user-facing metric)
|
|
260
|
+
- "React components render efficiently" (framework-specific)
|
|
261
|
+
- "Redis cache hit rate above 80%" (technology-specific)
|
|
@@ -0,0 +1,140 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Generate an actionable, dependency-ordered tasks.md for the feature based on available design artifacts.
|
|
3
|
+
handoffs:
|
|
4
|
+
- label: Analyze For Consistency
|
|
5
|
+
agent: speckit.analyze
|
|
6
|
+
prompt: Run a project analysis for consistency
|
|
7
|
+
send: true
|
|
8
|
+
- label: Implement Project
|
|
9
|
+
agent: speckit.implement
|
|
10
|
+
prompt: Start the implementation in phases
|
|
11
|
+
send: true
|
|
12
|
+
scripts:
|
|
13
|
+
sh: scripts/bash/check-prerequisites.sh --json
|
|
14
|
+
ps: scripts/powershell/check-prerequisites.ps1 -Json
|
|
15
|
+
---
|
|
16
|
+
|
|
17
|
+
## User Input
|
|
18
|
+
|
|
19
|
+
```text
|
|
20
|
+
$ARGUMENTS
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
You **MUST** consider the user input before proceeding (if not empty).
|
|
24
|
+
|
|
25
|
+
## Outline
|
|
26
|
+
|
|
27
|
+
1. **Setup**: Run `{SCRIPT}` from repo root and parse FEATURE_DIR and AVAILABLE_DOCS list. All paths must be absolute. For single quotes in args like "I'm Groot", use escape syntax: e.g 'I'\''m Groot' (or double-quote if possible: "I'm Groot").
|
|
28
|
+
|
|
29
|
+
2. **Load design documents**: Read from FEATURE_DIR:
|
|
30
|
+
- **Required**: plan.md (tech stack, libraries, structure), spec.md (user stories with priorities)
|
|
31
|
+
- **Optional**: data-model.md (entities), contracts/ (API endpoints), research.md (decisions), quickstart.md (test scenarios)
|
|
32
|
+
- Note: Not all projects have all documents. Generate tasks based on what's available.
|
|
33
|
+
|
|
34
|
+
3. **Execute task generation workflow**:
|
|
35
|
+
- Load plan.md and extract tech stack, libraries, project structure
|
|
36
|
+
- Load spec.md and extract user stories with their priorities (P1, P2, P3, etc.)
|
|
37
|
+
- If data-model.md exists: Extract entities and map to user stories
|
|
38
|
+
- If contracts/ exists: Map endpoints to user stories
|
|
39
|
+
- If research.md exists: Extract decisions for setup tasks
|
|
40
|
+
- Generate tasks organized by user story (see Task Generation Rules below)
|
|
41
|
+
- Generate dependency graph showing user story completion order
|
|
42
|
+
- Create parallel execution examples per user story
|
|
43
|
+
- Validate task completeness (each user story has all needed tasks, independently testable)
|
|
44
|
+
|
|
45
|
+
4. **Generate tasks.md**: Use `templates/tasks-template.md` as structure, fill with:
|
|
46
|
+
- Correct feature name from plan.md
|
|
47
|
+
- Phase 1: Setup tasks (project initialization)
|
|
48
|
+
- Phase 2: Foundational tasks (blocking prerequisites for all user stories)
|
|
49
|
+
- Phase 3+: One phase per user story (in priority order from spec.md)
|
|
50
|
+
- Each phase includes: story goal, independent test criteria, tests (if requested), implementation tasks
|
|
51
|
+
- Final Phase: Polish & cross-cutting concerns
|
|
52
|
+
- All tasks must follow the strict checklist format (see Task Generation Rules below)
|
|
53
|
+
- Clear file paths for each task
|
|
54
|
+
- Dependencies section showing story completion order
|
|
55
|
+
- Parallel execution examples per story
|
|
56
|
+
- Implementation strategy section (MVP first, incremental delivery)
|
|
57
|
+
|
|
58
|
+
5. **Report**: Output path to generated tasks.md and summary:
|
|
59
|
+
- Total task count
|
|
60
|
+
- Task count per user story
|
|
61
|
+
- Parallel opportunities identified
|
|
62
|
+
- Independent test criteria for each story
|
|
63
|
+
- Suggested MVP scope (typically just User Story 1)
|
|
64
|
+
- Format validation: Confirm ALL tasks follow the checklist format (checkbox, ID, labels, file paths)
|
|
65
|
+
|
|
66
|
+
Context for task generation: {ARGS}
|
|
67
|
+
|
|
68
|
+
The tasks.md should be immediately executable - each task must be specific enough that an LLM can complete it without additional context.
|
|
69
|
+
|
|
70
|
+
## Task Generation Rules
|
|
71
|
+
|
|
72
|
+
**CRITICAL**: Tasks MUST be organized by user story to enable independent implementation and testing.
|
|
73
|
+
|
|
74
|
+
**Tests are OPTIONAL**: Only generate test tasks if explicitly requested in the feature specification or if user requests TDD approach.
|
|
75
|
+
|
|
76
|
+
### Checklist Format (REQUIRED)
|
|
77
|
+
|
|
78
|
+
Every task MUST strictly follow this format:
|
|
79
|
+
|
|
80
|
+
```text
|
|
81
|
+
- [ ] [TaskID] [P?] [Story?] Description with file path
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
**Format Components**:
|
|
85
|
+
|
|
86
|
+
1. **Checkbox**: ALWAYS start with `- [ ]` (markdown checkbox)
|
|
87
|
+
2. **Task ID**: Sequential number (T001, T002, T003...) in execution order
|
|
88
|
+
3. **[P] marker**: Include ONLY if task is parallelizable (different files, no dependencies on incomplete tasks)
|
|
89
|
+
4. **[Story] label**: REQUIRED for user story phase tasks only
|
|
90
|
+
- Format: [US1], [US2], [US3], etc. (maps to user stories from spec.md)
|
|
91
|
+
- Setup phase: NO story label
|
|
92
|
+
- Foundational phase: NO story label
|
|
93
|
+
- User Story phases: MUST have story label
|
|
94
|
+
- Polish phase: NO story label
|
|
95
|
+
5. **Description**: Clear action with exact file path
|
|
96
|
+
|
|
97
|
+
**Examples**:
|
|
98
|
+
|
|
99
|
+
- ✅ CORRECT: `- [ ] T001 Create project structure per implementation plan`
|
|
100
|
+
- ✅ CORRECT: `- [ ] T005 [P] Implement authentication middleware in src/middleware/auth.py`
|
|
101
|
+
- ✅ CORRECT: `- [ ] T012 [P] [US1] Create User model in src/models/user.py`
|
|
102
|
+
- ✅ CORRECT: `- [ ] T014 [US1] Implement UserService in src/services/user_service.py`
|
|
103
|
+
- ❌ WRONG: `- [ ] Create User model` (missing ID and Story label)
|
|
104
|
+
- ❌ WRONG: `T001 [US1] Create model` (missing checkbox)
|
|
105
|
+
- ❌ WRONG: `- [ ] [US1] Create User model` (missing Task ID)
|
|
106
|
+
- ❌ WRONG: `- [ ] T001 [US1] Create model` (missing file path)
|
|
107
|
+
|
|
108
|
+
### Task Organization
|
|
109
|
+
|
|
110
|
+
1. **From User Stories (spec.md)** - PRIMARY ORGANIZATION:
|
|
111
|
+
- Each user story (P1, P2, P3...) gets its own phase
|
|
112
|
+
- Map all related components to their story:
|
|
113
|
+
- Models needed for that story
|
|
114
|
+
- Services needed for that story
|
|
115
|
+
- Endpoints/UI needed for that story
|
|
116
|
+
- If tests requested: Tests specific to that story
|
|
117
|
+
- Mark story dependencies (most stories should be independent)
|
|
118
|
+
|
|
119
|
+
2. **From Contracts**:
|
|
120
|
+
- Map each contract/endpoint → to the user story it serves
|
|
121
|
+
- If tests requested: Each contract → contract test task [P] before implementation in that story's phase
|
|
122
|
+
|
|
123
|
+
3. **From Data Model**:
|
|
124
|
+
- Map each entity to the user story(ies) that need it
|
|
125
|
+
- If entity serves multiple stories: Put in earliest story or Setup phase
|
|
126
|
+
- Relationships → service layer tasks in appropriate story phase
|
|
127
|
+
|
|
128
|
+
4. **From Setup/Infrastructure**:
|
|
129
|
+
- Shared infrastructure → Setup phase (Phase 1)
|
|
130
|
+
- Foundational/blocking tasks → Foundational phase (Phase 2)
|
|
131
|
+
- Story-specific setup → within that story's phase
|
|
132
|
+
|
|
133
|
+
### Phase Structure
|
|
134
|
+
|
|
135
|
+
- **Phase 1**: Setup (project initialization)
|
|
136
|
+
- **Phase 2**: Foundational (blocking prerequisites - MUST complete before user stories)
|
|
137
|
+
- **Phase 3+**: User Stories in priority order (P1, P2, P3...)
|
|
138
|
+
- Within each story: Tests (if requested) → Models → Services → Endpoints → Integration
|
|
139
|
+
- Each phase should be a complete, independently testable increment
|
|
140
|
+
- **Final Phase**: Polish & Cross-Cutting Concerns
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Convert existing tasks into actionable, dependency-ordered GitHub issues for the feature based on available design artifacts.
|
|
3
|
+
tools: ['github/github-mcp-server/issue_write']
|
|
4
|
+
scripts:
|
|
5
|
+
sh: scripts/bash/check-prerequisites.sh --json --require-tasks --include-tasks
|
|
6
|
+
ps: scripts/powershell/check-prerequisites.ps1 -Json -RequireTasks -IncludeTasks
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## User Input
|
|
10
|
+
|
|
11
|
+
```text
|
|
12
|
+
$ARGUMENTS
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
You **MUST** consider the user input before proceeding (if not empty).
|
|
16
|
+
|
|
17
|
+
## Outline
|
|
18
|
+
|
|
19
|
+
1. Run `{SCRIPT}` from repo root and parse FEATURE_DIR and AVAILABLE_DOCS list. All paths must be absolute. For single quotes in args like "I'm Groot", use escape syntax: e.g 'I'\''m Groot' (or double-quote if possible: "I'm Groot").
|
|
20
|
+
1. From the executed script, extract the path to **tasks**.
|
|
21
|
+
1. Get the Git remote by running:
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
git config --get remote.origin.url
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
> [!CAUTION]
|
|
28
|
+
> ONLY PROCEED TO NEXT STEPS IF THE REMOTE IS A GITHUB URL
|
|
29
|
+
|
|
30
|
+
1. For each task in the list, use the GitHub MCP server to create a new issue in the repository that is representative of the Git remote.
|
|
31
|
+
|
|
32
|
+
> [!CAUTION]
|
|
33
|
+
> UNDER NO CIRCUMSTANCES EVER CREATE ISSUES IN REPOSITORIES THAT DO NOT MATCH THE REMOTE URL
|
|
@@ -0,0 +1,104 @@
|
|
|
1
|
+
# Implementation Plan: [FEATURE]
|
|
2
|
+
|
|
3
|
+
**Branch**: `[###-feature-name]` | **Date**: [DATE] | **Spec**: [link]
|
|
4
|
+
**Input**: Feature specification from `/specs/[###-feature-name]/spec.md`
|
|
5
|
+
|
|
6
|
+
**Note**: This template is filled in by the `/speckit.plan` command. See `.specify/templates/commands/plan.md` for the execution workflow.
|
|
7
|
+
|
|
8
|
+
## Summary
|
|
9
|
+
|
|
10
|
+
[Extract from feature spec: primary requirement + technical approach from research]
|
|
11
|
+
|
|
12
|
+
## Technical Context
|
|
13
|
+
|
|
14
|
+
<!--
|
|
15
|
+
ACTION REQUIRED: Replace the content in this section with the technical details
|
|
16
|
+
for the project. The structure here is presented in advisory capacity to guide
|
|
17
|
+
the iteration process.
|
|
18
|
+
-->
|
|
19
|
+
|
|
20
|
+
**Language/Version**: [e.g., Python 3.11, Swift 5.9, Rust 1.75 or NEEDS CLARIFICATION]
|
|
21
|
+
**Primary Dependencies**: [e.g., FastAPI, UIKit, LLVM or NEEDS CLARIFICATION]
|
|
22
|
+
**Storage**: [if applicable, e.g., PostgreSQL, CoreData, files or N/A]
|
|
23
|
+
**Testing**: [e.g., pytest, XCTest, cargo test or NEEDS CLARIFICATION]
|
|
24
|
+
**Target Platform**: [e.g., Linux server, iOS 15+, WASM or NEEDS CLARIFICATION]
|
|
25
|
+
**Project Type**: [single/web/mobile - determines source structure]
|
|
26
|
+
**Performance Goals**: [domain-specific, e.g., 1000 req/s, 10k lines/sec, 60 fps or NEEDS CLARIFICATION]
|
|
27
|
+
**Constraints**: [domain-specific, e.g., <200ms p95, <100MB memory, offline-capable or NEEDS CLARIFICATION]
|
|
28
|
+
**Scale/Scope**: [domain-specific, e.g., 10k users, 1M LOC, 50 screens or NEEDS CLARIFICATION]
|
|
29
|
+
|
|
30
|
+
## Constitution Check
|
|
31
|
+
|
|
32
|
+
*GATE: Must pass before Phase 0 research. Re-check after Phase 1 design.*
|
|
33
|
+
|
|
34
|
+
[Gates determined based on constitution file]
|
|
35
|
+
|
|
36
|
+
## Project Structure
|
|
37
|
+
|
|
38
|
+
### Documentation (this feature)
|
|
39
|
+
|
|
40
|
+
```text
|
|
41
|
+
specs/[###-feature]/
|
|
42
|
+
├── plan.md # This file (/speckit.plan command output)
|
|
43
|
+
├── research.md # Phase 0 output (/speckit.plan command)
|
|
44
|
+
├── data-model.md # Phase 1 output (/speckit.plan command)
|
|
45
|
+
├── quickstart.md # Phase 1 output (/speckit.plan command)
|
|
46
|
+
├── contracts/ # Phase 1 output (/speckit.plan command)
|
|
47
|
+
└── tasks.md # Phase 2 output (/speckit.tasks command - NOT created by /speckit.plan)
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
### Source Code (repository root)
|
|
51
|
+
<!--
|
|
52
|
+
ACTION REQUIRED: Replace the placeholder tree below with the concrete layout
|
|
53
|
+
for this feature. Delete unused options and expand the chosen structure with
|
|
54
|
+
real paths (e.g., apps/admin, packages/something). The delivered plan must
|
|
55
|
+
not include Option labels.
|
|
56
|
+
-->
|
|
57
|
+
|
|
58
|
+
```text
|
|
59
|
+
# [REMOVE IF UNUSED] Option 1: Single project (DEFAULT)
|
|
60
|
+
src/
|
|
61
|
+
├── models/
|
|
62
|
+
├── services/
|
|
63
|
+
├── cli/
|
|
64
|
+
└── lib/
|
|
65
|
+
|
|
66
|
+
tests/
|
|
67
|
+
├── contract/
|
|
68
|
+
├── integration/
|
|
69
|
+
└── unit/
|
|
70
|
+
|
|
71
|
+
# [REMOVE IF UNUSED] Option 2: Web application (when "frontend" + "backend" detected)
|
|
72
|
+
backend/
|
|
73
|
+
├── src/
|
|
74
|
+
│ ├── models/
|
|
75
|
+
│ ├── services/
|
|
76
|
+
│ └── api/
|
|
77
|
+
└── tests/
|
|
78
|
+
|
|
79
|
+
frontend/
|
|
80
|
+
├── src/
|
|
81
|
+
│ ├── components/
|
|
82
|
+
│ ├── pages/
|
|
83
|
+
│ └── services/
|
|
84
|
+
└── tests/
|
|
85
|
+
|
|
86
|
+
# [REMOVE IF UNUSED] Option 3: Mobile + API (when "iOS/Android" detected)
|
|
87
|
+
api/
|
|
88
|
+
└── [same as backend above]
|
|
89
|
+
|
|
90
|
+
ios/ or android/
|
|
91
|
+
└── [platform-specific structure: feature modules, UI flows, platform tests]
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
**Structure Decision**: [Document the selected structure and reference the real
|
|
95
|
+
directories captured above]
|
|
96
|
+
|
|
97
|
+
## Complexity Tracking
|
|
98
|
+
|
|
99
|
+
> **Fill ONLY if Constitution Check has violations that must be justified**
|
|
100
|
+
|
|
101
|
+
| Violation | Why Needed | Simpler Alternative Rejected Because |
|
|
102
|
+
|-----------|------------|-------------------------------------|
|
|
103
|
+
| [e.g., 4th project] | [current need] | [why 3 projects insufficient] |
|
|
104
|
+
| [e.g., Repository pattern] | [specific problem] | [why direct DB access insufficient] |
|
|
@@ -0,0 +1,115 @@
|
|
|
1
|
+
# Feature Specification: [FEATURE NAME]
|
|
2
|
+
|
|
3
|
+
**Feature Branch**: `[###-feature-name]`
|
|
4
|
+
**Created**: [DATE]
|
|
5
|
+
**Status**: Draft
|
|
6
|
+
**Input**: User description: "$ARGUMENTS"
|
|
7
|
+
|
|
8
|
+
## User Scenarios & Testing *(mandatory)*
|
|
9
|
+
|
|
10
|
+
<!--
|
|
11
|
+
IMPORTANT: User stories should be PRIORITIZED as user journeys ordered by importance.
|
|
12
|
+
Each user story/journey must be INDEPENDENTLY TESTABLE - meaning if you implement just ONE of them,
|
|
13
|
+
you should still have a viable MVP (Minimum Viable Product) that delivers value.
|
|
14
|
+
|
|
15
|
+
Assign priorities (P1, P2, P3, etc.) to each story, where P1 is the most critical.
|
|
16
|
+
Think of each story as a standalone slice of functionality that can be:
|
|
17
|
+
- Developed independently
|
|
18
|
+
- Tested independently
|
|
19
|
+
- Deployed independently
|
|
20
|
+
- Demonstrated to users independently
|
|
21
|
+
-->
|
|
22
|
+
|
|
23
|
+
### User Story 1 - [Brief Title] (Priority: P1)
|
|
24
|
+
|
|
25
|
+
[Describe this user journey in plain language]
|
|
26
|
+
|
|
27
|
+
**Why this priority**: [Explain the value and why it has this priority level]
|
|
28
|
+
|
|
29
|
+
**Independent Test**: [Describe how this can be tested independently - e.g., "Can be fully tested by [specific action] and delivers [specific value]"]
|
|
30
|
+
|
|
31
|
+
**Acceptance Scenarios**:
|
|
32
|
+
|
|
33
|
+
1. **Given** [initial state], **When** [action], **Then** [expected outcome]
|
|
34
|
+
2. **Given** [initial state], **When** [action], **Then** [expected outcome]
|
|
35
|
+
|
|
36
|
+
---
|
|
37
|
+
|
|
38
|
+
### User Story 2 - [Brief Title] (Priority: P2)
|
|
39
|
+
|
|
40
|
+
[Describe this user journey in plain language]
|
|
41
|
+
|
|
42
|
+
**Why this priority**: [Explain the value and why it has this priority level]
|
|
43
|
+
|
|
44
|
+
**Independent Test**: [Describe how this can be tested independently]
|
|
45
|
+
|
|
46
|
+
**Acceptance Scenarios**:
|
|
47
|
+
|
|
48
|
+
1. **Given** [initial state], **When** [action], **Then** [expected outcome]
|
|
49
|
+
|
|
50
|
+
---
|
|
51
|
+
|
|
52
|
+
### User Story 3 - [Brief Title] (Priority: P3)
|
|
53
|
+
|
|
54
|
+
[Describe this user journey in plain language]
|
|
55
|
+
|
|
56
|
+
**Why this priority**: [Explain the value and why it has this priority level]
|
|
57
|
+
|
|
58
|
+
**Independent Test**: [Describe how this can be tested independently]
|
|
59
|
+
|
|
60
|
+
**Acceptance Scenarios**:
|
|
61
|
+
|
|
62
|
+
1. **Given** [initial state], **When** [action], **Then** [expected outcome]
|
|
63
|
+
|
|
64
|
+
---
|
|
65
|
+
|
|
66
|
+
[Add more user stories as needed, each with an assigned priority]
|
|
67
|
+
|
|
68
|
+
### Edge Cases
|
|
69
|
+
|
|
70
|
+
<!--
|
|
71
|
+
ACTION REQUIRED: The content in this section represents placeholders.
|
|
72
|
+
Fill them out with the right edge cases.
|
|
73
|
+
-->
|
|
74
|
+
|
|
75
|
+
- What happens when [boundary condition]?
|
|
76
|
+
- How does system handle [error scenario]?
|
|
77
|
+
|
|
78
|
+
## Requirements *(mandatory)*
|
|
79
|
+
|
|
80
|
+
<!--
|
|
81
|
+
ACTION REQUIRED: The content in this section represents placeholders.
|
|
82
|
+
Fill them out with the right functional requirements.
|
|
83
|
+
-->
|
|
84
|
+
|
|
85
|
+
### Functional Requirements
|
|
86
|
+
|
|
87
|
+
- **FR-001**: System MUST [specific capability, e.g., "allow users to create accounts"]
|
|
88
|
+
- **FR-002**: System MUST [specific capability, e.g., "validate email addresses"]
|
|
89
|
+
- **FR-003**: Users MUST be able to [key interaction, e.g., "reset their password"]
|
|
90
|
+
- **FR-004**: System MUST [data requirement, e.g., "persist user preferences"]
|
|
91
|
+
- **FR-005**: System MUST [behavior, e.g., "log all security events"]
|
|
92
|
+
|
|
93
|
+
*Example of marking unclear requirements:*
|
|
94
|
+
|
|
95
|
+
- **FR-006**: System MUST authenticate users via [NEEDS CLARIFICATION: auth method not specified - email/password, SSO, OAuth?]
|
|
96
|
+
- **FR-007**: System MUST retain user data for [NEEDS CLARIFICATION: retention period not specified]
|
|
97
|
+
|
|
98
|
+
### Key Entities *(include if feature involves data)*
|
|
99
|
+
|
|
100
|
+
- **[Entity 1]**: [What it represents, key attributes without implementation]
|
|
101
|
+
- **[Entity 2]**: [What it represents, relationships to other entities]
|
|
102
|
+
|
|
103
|
+
## Success Criteria *(mandatory)*
|
|
104
|
+
|
|
105
|
+
<!--
|
|
106
|
+
ACTION REQUIRED: Define measurable success criteria.
|
|
107
|
+
These must be technology-agnostic and measurable.
|
|
108
|
+
-->
|
|
109
|
+
|
|
110
|
+
### Measurable Outcomes
|
|
111
|
+
|
|
112
|
+
- **SC-001**: [Measurable metric, e.g., "Users can complete account creation in under 2 minutes"]
|
|
113
|
+
- **SC-002**: [Measurable metric, e.g., "System handles 1000 concurrent users without degradation"]
|
|
114
|
+
- **SC-003**: [User satisfaction metric, e.g., "90% of users successfully complete primary task on first attempt"]
|
|
115
|
+
- **SC-004**: [Business metric, e.g., "Reduce support tickets related to [X] by 50%"]
|