@totaland/create-starter-kit 1.0.0 → 2.0.1
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/README.md +130 -18
- package/bin/index.js +109 -21
- package/package.json +2 -2
- package/templates/backend/.github/agents/ /360/237/216/255 planner.agent.md" +92 -0
- package/templates/backend/.github/agents/api-architect.agent.md +41 -0
- package/templates/backend/.github/agents/code-reviewer.agent.md +26 -0
- package/templates/backend/.github/agents/code-simplifier.agent.md +41 -0
- package/templates/backend/.github/agents/code-skeptic.agent.md +74 -0
- package/templates/backend/.github/agents/docs-specialist.agent.md +25 -0
- package/templates/backend/.github/agents/implementation-plan.agent.md +160 -0
- package/templates/backend/.github/agents/janitor.agent.md +90 -0
- package/templates/backend/.github/agents/ms-sql-dba.agent.md +25 -0
- package/templates/backend/.github/agents/plan.agent.md +115 -0
- package/templates/backend/.github/agents/planner.agent.md +15 -0
- package/templates/backend/.github/agents/playwright-tester.agent.md +13 -0
- package/templates/backend/.github/agents/postgresql-dba.agent.md +18 -0
- package/templates/backend/.github/agents/prd.agent.md +202 -0
- package/templates/backend/.github/agents/research-technical-spike.agent.md +170 -0
- package/templates/backend/.github/agents/software-engineer-agent-v1.agent.md +165 -0
- package/templates/backend/.github/agents/task-planner.agent.md +375 -0
- package/templates/backend/.github/agents/task-researcher.agent.md +255 -0
- package/templates/backend/.github/agents/tdd-green.agent.md +60 -0
- package/templates/backend/.github/agents/tdd-red.agent.md +60 -0
- package/templates/backend/.github/agents/tdd-refactor.agent.md +85 -0
- package/templates/backend/.github/agents/tech-debt-remediation-plan.agent.md +50 -0
- package/templates/backend/.github/agents/typescript-mcp-expert.agent.md +91 -0
- package/templates/backend/.github/agents/ultimate-thinking-beastmode.agent.md +644 -0
- package/templates/backend/.github/agents//360/237/216/255 generator.agent.md" +264 -0
- package/templates/backend/.github/agents//360/237/216/255 healer.agent.md" +44 -0
- package/templates/backend/.github/agents//360/237/216/255 pom.agent.md" +308 -0
- package/templates/backend/.github/instructions/a11y.instructions.md +369 -0
- package/templates/backend/.github/instructions/ms-sql-dba.instructions.md +25 -0
- package/templates/backend/.github/instructions/object-calisthenics.instructions.md +302 -0
- package/templates/backend/.github/instructions/performance-optimization.instructions.md +420 -0
- package/templates/backend/.github/instructions/playwright-python.instructions.md +62 -0
- package/templates/backend/.github/instructions/playwright-typescript.instructions.md +86 -0
- package/templates/backend/.github/instructions/security-and-owasp.instructions.md +51 -0
- package/templates/backend/.github/instructions/self-explanatory-code-commenting.instructions.md +162 -0
- package/templates/backend/.github/instructions/spec-driven-workflow-v1.instructions.md +323 -0
- package/templates/backend/.github/instructions/sql-sp-generation.instructions.md +74 -0
- package/templates/backend/.github/instructions/task-implementation.instructions.md +190 -0
- package/templates/backend/.github/instructions/typescript-mcp-server.instructions.md +228 -0
- package/templates/backend/.github/prompts/ai-prompt-engineering-safety-review.prompt.md +229 -0
- package/templates/backend/.github/prompts/architecture-blueprint-generator.prompt.md +321 -0
- package/templates/backend/.github/prompts/breakdown-epic-arch.prompt.md +65 -0
- package/templates/backend/.github/prompts/breakdown-epic-pm.prompt.md +57 -0
- package/templates/backend/.github/prompts/breakdown-feature-implementation.prompt.md +127 -0
- package/templates/backend/.github/prompts/breakdown-feature-prd.prompt.md +60 -0
- package/templates/backend/.github/prompts/breakdown-plan.prompt.md +508 -0
- package/templates/backend/.github/prompts/copilot-instructions-blueprint-generator.prompt.md +293 -0
- package/templates/backend/.github/prompts/create-agentsmd.prompt.md +248 -0
- package/templates/backend/.github/prompts/create-github-issue-feature-from-specification.prompt.md +27 -0
- package/templates/backend/.github/prompts/create-github-issues-feature-from-implementation-plan.prompt.md +27 -0
- package/templates/backend/.github/prompts/create-github-issues-for-unmet-specification-requirements.prompt.md +35 -0
- package/templates/backend/.github/prompts/create-implementation-plan.prompt.md +156 -0
- package/templates/backend/.github/prompts/create-llms.prompt.md +209 -0
- package/templates/backend/.github/prompts/create-specification.prompt.md +126 -0
- package/templates/backend/.github/prompts/create-technical-spike.prompt.md +230 -0
- package/templates/backend/.github/prompts/csharp-nunit.prompt.md +71 -0
- package/templates/backend/.github/prompts/ef-core.prompt.md +76 -0
- package/templates/backend/.github/prompts/folder-structure-blueprint-generator.prompt.md +404 -0
- package/templates/backend/.github/prompts/gen-specs-as-issues.prompt.md +165 -0
- package/templates/backend/.github/prompts/generate-custom-instructions-from-codebase.prompt.md +239 -0
- package/templates/backend/.github/prompts/java-junit.prompt.md +64 -0
- package/templates/backend/.github/prompts/memory-merger.prompt.md +107 -0
- package/templates/backend/.github/prompts/multi-stage-dockerfile.prompt.md +46 -0
- package/templates/backend/.github/prompts/playwright-automation-fill-in-form.prompt.md +29 -0
- package/templates/backend/.github/prompts/playwright-explore-website.prompt.md +19 -0
- package/templates/backend/.github/prompts/playwright-generate-test.prompt.md +19 -0
- package/templates/backend/.github/prompts/postgresql-code-review.prompt.md +214 -0
- package/templates/backend/.github/prompts/postgresql-optimization.prompt.md +406 -0
- package/templates/backend/.github/prompts/project-workflow-analysis-blueprint-generator.prompt.md +294 -0
- package/templates/backend/.github/prompts/prompt-builder.prompt.md +142 -0
- package/templates/backend/.github/prompts/remember.prompt.md +125 -0
- package/templates/backend/.github/prompts/review-and-refactor.prompt.md +15 -0
- package/templates/backend/.github/prompts/sql-code-review.prompt.md +303 -0
- package/templates/backend/.github/prompts/sql-optimization.prompt.md +298 -0
- package/templates/backend/.github/prompts/suggest-awesome-github-copilot-agents.prompt.md +72 -0
- package/templates/backend/.github/prompts/suggest-awesome-github-copilot-chatmodes.prompt.md +71 -0
- package/templates/backend/.github/prompts/suggest-awesome-github-copilot-collections.prompt.md +149 -0
- package/templates/backend/.github/prompts/suggest-awesome-github-copilot-instructions.prompt.md +88 -0
- package/templates/backend/.github/prompts/suggest-awesome-github-copilot-prompts.prompt.md +71 -0
- package/templates/backend/.github/prompts/technology-stack-blueprint-generator.prompt.md +242 -0
- package/templates/backend/.github/prompts/typescript-mcp-server-generator.prompt.md +90 -0
- package/templates/backend/.github/prompts/update-implementation-plan.prompt.md +157 -0
- package/templates/backend/.github/prompts/update-markdown-file-index.prompt.md +76 -0
- package/templates/backend/Project_Folders_Structure_Blueprint.md +529 -0
- package/templates/backend/README.md +99 -0
- package/templates/backend/biome.json +45 -0
- package/{template → templates/backend}/drizzle.config.ts +1 -1
- package/{template → templates/backend}/package.json +9 -4
- package/templates/backend/pnpm-lock.yaml +4240 -0
- package/templates/backend/src/features/health/health.test.ts +23 -0
- package/{template → templates/backend}/src/features/health/index.ts +1 -0
- package/templates/backend/src/features/health/schemas.ts +29 -0
- package/templates/backend/src/features/orders/controller.ts +18 -0
- package/templates/backend/src/features/orders/index.ts +10 -0
- package/templates/backend/src/features/orders/schemas.ts +62 -0
- package/{template → templates/backend}/src/index.ts +3 -36
- package/templates/backend/src/lib/openapi.ts +25 -0
- package/templates/backend/src/lib/validateRequest.test.ts +84 -0
- package/templates/backend/src/lib/validateRequest.ts +72 -0
- package/{template → templates/backend}/tsconfig.json +2 -2
- package/{template → templates/backend}/vitest.config.ts +8 -1
- package/templates/frontend/.env.example +7 -0
- package/templates/frontend/.github/agents/ /360/237/216/255 planner.agent.md" +92 -0
- package/templates/frontend/.github/agents/api-architect.agent.md +41 -0
- package/templates/frontend/.github/agents/code-reviewer.agent.md +26 -0
- package/templates/frontend/.github/agents/code-simplifier.agent.md +41 -0
- package/templates/frontend/.github/agents/code-skeptic.agent.md +74 -0
- package/templates/frontend/.github/agents/docs-specialist.agent.md +25 -0
- package/templates/frontend/.github/agents/implementation-plan.agent.md +160 -0
- package/templates/frontend/.github/agents/janitor.agent.md +90 -0
- package/templates/frontend/.github/agents/ms-sql-dba.agent.md +25 -0
- package/templates/frontend/.github/agents/plan.agent.md +115 -0
- package/templates/frontend/.github/agents/planner.agent.md +15 -0
- package/templates/frontend/.github/agents/playwright-tester.agent.md +13 -0
- package/templates/frontend/.github/agents/postgresql-dba.agent.md +18 -0
- package/templates/frontend/.github/agents/prd.agent.md +202 -0
- package/templates/frontend/.github/agents/research-technical-spike.agent.md +170 -0
- package/templates/frontend/.github/agents/software-engineer-agent-v1.agent.md +165 -0
- package/templates/frontend/.github/agents/task-planner.agent.md +375 -0
- package/templates/frontend/.github/agents/task-researcher.agent.md +255 -0
- package/templates/frontend/.github/agents/tdd-green.agent.md +60 -0
- package/templates/frontend/.github/agents/tdd-red.agent.md +60 -0
- package/templates/frontend/.github/agents/tdd-refactor.agent.md +85 -0
- package/templates/frontend/.github/agents/tech-debt-remediation-plan.agent.md +50 -0
- package/templates/frontend/.github/agents/typescript-mcp-expert.agent.md +91 -0
- package/templates/frontend/.github/agents/ultimate-thinking-beastmode.agent.md +644 -0
- package/templates/frontend/.github/agents//360/237/216/255 generator.agent.md" +264 -0
- package/templates/frontend/.github/agents//360/237/216/255 healer.agent.md" +44 -0
- package/templates/frontend/.github/agents//360/237/216/255 pom.agent.md" +308 -0
- package/templates/frontend/.github/instructions/a11y.instructions.md +369 -0
- package/templates/frontend/.github/instructions/ms-sql-dba.instructions.md +25 -0
- package/templates/frontend/.github/instructions/object-calisthenics.instructions.md +302 -0
- package/templates/frontend/.github/instructions/performance-optimization.instructions.md +420 -0
- package/templates/frontend/.github/instructions/playwright-python.instructions.md +62 -0
- package/templates/frontend/.github/instructions/playwright-typescript.instructions.md +86 -0
- package/templates/frontend/.github/instructions/security-and-owasp.instructions.md +51 -0
- package/templates/frontend/.github/instructions/self-explanatory-code-commenting.instructions.md +162 -0
- package/templates/frontend/.github/instructions/spec-driven-workflow-v1.instructions.md +323 -0
- package/templates/frontend/.github/instructions/sql-sp-generation.instructions.md +74 -0
- package/templates/frontend/.github/instructions/task-implementation.instructions.md +190 -0
- package/templates/frontend/.github/instructions/typescript-mcp-server.instructions.md +228 -0
- package/templates/frontend/.github/prompts/ai-prompt-engineering-safety-review.prompt.md +229 -0
- package/templates/frontend/.github/prompts/architecture-blueprint-generator.prompt.md +321 -0
- package/templates/frontend/.github/prompts/breakdown-epic-arch.prompt.md +65 -0
- package/templates/frontend/.github/prompts/breakdown-epic-pm.prompt.md +57 -0
- package/templates/frontend/.github/prompts/breakdown-feature-implementation.prompt.md +127 -0
- package/templates/frontend/.github/prompts/breakdown-feature-prd.prompt.md +60 -0
- package/templates/frontend/.github/prompts/breakdown-plan.prompt.md +508 -0
- package/templates/frontend/.github/prompts/copilot-instructions-blueprint-generator.prompt.md +293 -0
- package/templates/frontend/.github/prompts/create-agentsmd.prompt.md +248 -0
- package/templates/frontend/.github/prompts/create-github-issue-feature-from-specification.prompt.md +27 -0
- package/templates/frontend/.github/prompts/create-github-issues-feature-from-implementation-plan.prompt.md +27 -0
- package/templates/frontend/.github/prompts/create-github-issues-for-unmet-specification-requirements.prompt.md +35 -0
- package/templates/frontend/.github/prompts/create-implementation-plan.prompt.md +156 -0
- package/templates/frontend/.github/prompts/create-llms.prompt.md +209 -0
- package/templates/frontend/.github/prompts/create-specification.prompt.md +126 -0
- package/templates/frontend/.github/prompts/create-technical-spike.prompt.md +230 -0
- package/templates/frontend/.github/prompts/csharp-nunit.prompt.md +71 -0
- package/templates/frontend/.github/prompts/ef-core.prompt.md +76 -0
- package/templates/frontend/.github/prompts/folder-structure-blueprint-generator.prompt.md +404 -0
- package/templates/frontend/.github/prompts/gen-specs-as-issues.prompt.md +165 -0
- package/templates/frontend/.github/prompts/generate-custom-instructions-from-codebase.prompt.md +239 -0
- package/templates/frontend/.github/prompts/java-junit.prompt.md +64 -0
- package/templates/frontend/.github/prompts/memory-merger.prompt.md +107 -0
- package/templates/frontend/.github/prompts/multi-stage-dockerfile.prompt.md +46 -0
- package/templates/frontend/.github/prompts/playwright-automation-fill-in-form.prompt.md +29 -0
- package/templates/frontend/.github/prompts/playwright-explore-website.prompt.md +19 -0
- package/templates/frontend/.github/prompts/playwright-generate-test.prompt.md +19 -0
- package/templates/frontend/.github/prompts/postgresql-code-review.prompt.md +214 -0
- package/templates/frontend/.github/prompts/postgresql-optimization.prompt.md +406 -0
- package/templates/frontend/.github/prompts/project-workflow-analysis-blueprint-generator.prompt.md +294 -0
- package/templates/frontend/.github/prompts/prompt-builder.prompt.md +142 -0
- package/templates/frontend/.github/prompts/remember.prompt.md +125 -0
- package/templates/frontend/.github/prompts/review-and-refactor.prompt.md +15 -0
- package/templates/frontend/.github/prompts/sql-code-review.prompt.md +303 -0
- package/templates/frontend/.github/prompts/sql-optimization.prompt.md +298 -0
- package/templates/frontend/.github/prompts/suggest-awesome-github-copilot-agents.prompt.md +72 -0
- package/templates/frontend/.github/prompts/suggest-awesome-github-copilot-chatmodes.prompt.md +71 -0
- package/templates/frontend/.github/prompts/suggest-awesome-github-copilot-collections.prompt.md +149 -0
- package/templates/frontend/.github/prompts/suggest-awesome-github-copilot-instructions.prompt.md +88 -0
- package/templates/frontend/.github/prompts/suggest-awesome-github-copilot-prompts.prompt.md +71 -0
- package/templates/frontend/.github/prompts/technology-stack-blueprint-generator.prompt.md +242 -0
- package/templates/frontend/.github/prompts/typescript-mcp-server-generator.prompt.md +90 -0
- package/templates/frontend/.github/prompts/update-implementation-plan.prompt.md +157 -0
- package/templates/frontend/.github/prompts/update-markdown-file-index.prompt.md +76 -0
- package/templates/frontend/README.md +199 -0
- package/templates/frontend/biome.json +45 -0
- package/templates/frontend/components.json +22 -0
- package/templates/frontend/index.html +13 -0
- package/templates/frontend/package.json +44 -0
- package/templates/frontend/pnpm-lock.yaml +2011 -0
- package/templates/frontend/postcss.config.js +6 -0
- package/templates/frontend/public/vite.svg +1 -0
- package/templates/frontend/src/App.css +42 -0
- package/templates/frontend/src/App.tsx +17 -0
- package/templates/frontend/src/assets/react.svg +1 -0
- package/templates/frontend/src/components/layout/layout.component.tsx +31 -0
- package/templates/frontend/src/components/menu-toggle-icon.tsx +53 -0
- package/templates/frontend/src/components/ui/button.tsx +57 -0
- package/templates/frontend/src/docs/RECOMMENDED_LIBRARIES.md +226 -0
- package/templates/frontend/src/docs/SETUP_SUMMARY.md +162 -0
- package/templates/frontend/src/hooks/use-scroll.ts +21 -0
- package/templates/frontend/src/index.css +121 -0
- package/templates/frontend/src/lib/api-client.ts +46 -0
- package/templates/frontend/src/lib/utils.ts +6 -0
- package/templates/frontend/src/main.tsx +30 -0
- package/templates/frontend/src/pages/about/about.page.tsx +50 -0
- package/templates/frontend/src/pages/home/home.page.tsx +43 -0
- package/templates/frontend/tailwind.config.js +59 -0
- package/templates/frontend/tsconfig.app.json +41 -0
- package/templates/frontend/tsconfig.json +13 -0
- package/templates/frontend/tsconfig.node.json +26 -0
- package/templates/frontend/vite.config.ts +14 -0
- package/template/.env.example +0 -8
- package/template/AGENTS.md +0 -23
- package/template/ARCHITECTURE.md +0 -53
- package/template/ORDER_SYSTEM.md +0 -93
- package/template/biome.json +0 -3
- package/template/src/features/orders/controller.ts +0 -13
- package/template/src/features/orders/index.ts +0 -7
- /package/{template → templates/backend}/knip.json +0 -0
- /package/{template → templates/backend}/playwright.config.ts +0 -0
- /package/{template → templates/backend}/pnpm-workspace.yaml +0 -0
- /package/{template → templates/backend}/src/features/health/controller.ts +0 -0
- /package/{template → templates/backend}/tsconfig.build.json +0 -0
|
@@ -0,0 +1,156 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: 'Create a new implementation plan file for new features, refactoring existing code or upgrading packages, design, architecture or infrastructure.'
|
|
3
|
+
tools: ['changes', 'search/codebase', 'edit/editFiles', 'extensions', 'fetch', 'githubRepo', 'openSimpleBrowser', 'problems', 'runTasks', 'search', 'search/searchResults', 'runCommands/terminalLastCommand', 'runCommands/terminalSelection', 'testFailure', 'usages', 'vscodeAPI']
|
|
4
|
+
---
|
|
5
|
+
# Create Implementation Plan
|
|
6
|
+
|
|
7
|
+
## Primary Directive
|
|
8
|
+
|
|
9
|
+
Your goal is to create a new implementation plan file for `${input:PlanPurpose}`. Your output must be machine-readable, deterministic, and structured for autonomous execution by other AI systems or humans.
|
|
10
|
+
|
|
11
|
+
## Execution Context
|
|
12
|
+
|
|
13
|
+
This prompt is designed for AI-to-AI communication and automated processing. All instructions must be interpreted literally and executed systematically without human interpretation or clarification.
|
|
14
|
+
|
|
15
|
+
## Core Requirements
|
|
16
|
+
|
|
17
|
+
- Generate implementation plans that are fully executable by AI agents or humans
|
|
18
|
+
- Use deterministic language with zero ambiguity
|
|
19
|
+
- Structure all content for automated parsing and execution
|
|
20
|
+
- Ensure complete self-containment with no external dependencies for understanding
|
|
21
|
+
|
|
22
|
+
## Plan Structure Requirements
|
|
23
|
+
|
|
24
|
+
Plans must consist of discrete, atomic phases containing executable tasks. Each phase must be independently processable by AI agents or humans without cross-phase dependencies unless explicitly declared.
|
|
25
|
+
|
|
26
|
+
## Phase Architecture
|
|
27
|
+
|
|
28
|
+
- Each phase must have measurable completion criteria
|
|
29
|
+
- Tasks within phases must be executable in parallel unless dependencies are specified
|
|
30
|
+
- All task descriptions must include specific file paths, function names, and exact implementation details
|
|
31
|
+
- No task should require human interpretation or decision-making
|
|
32
|
+
|
|
33
|
+
## AI-Optimized Implementation Standards
|
|
34
|
+
|
|
35
|
+
- Use explicit, unambiguous language with zero interpretation required
|
|
36
|
+
- Structure all content as machine-parseable formats (tables, lists, structured data)
|
|
37
|
+
- Include specific file paths, line numbers, and exact code references where applicable
|
|
38
|
+
- Define all variables, constants, and configuration values explicitly
|
|
39
|
+
- Provide complete context within each task description
|
|
40
|
+
- Use standardized prefixes for all identifiers (REQ-, TASK-, etc.)
|
|
41
|
+
- Include validation criteria that can be automatically verified
|
|
42
|
+
|
|
43
|
+
## Output File Specifications
|
|
44
|
+
|
|
45
|
+
- Save implementation plan files in `/plan/` directory
|
|
46
|
+
- Use naming convention: `[purpose]-[component]-[version].md`
|
|
47
|
+
- Purpose prefixes: `upgrade|refactor|feature|data|infrastructure|process|architecture|design`
|
|
48
|
+
- Example: `upgrade-system-command-4.md`, `feature-auth-module-1.md`
|
|
49
|
+
- File must be valid Markdown with proper front matter structure
|
|
50
|
+
|
|
51
|
+
## Mandatory Template Structure
|
|
52
|
+
|
|
53
|
+
All implementation plans must strictly adhere to the following template. Each section is required and must be populated with specific, actionable content. AI agents must validate template compliance before execution.
|
|
54
|
+
|
|
55
|
+
## Template Validation Rules
|
|
56
|
+
|
|
57
|
+
- All front matter fields must be present and properly formatted
|
|
58
|
+
- All section headers must match exactly (case-sensitive)
|
|
59
|
+
- All identifier prefixes must follow the specified format
|
|
60
|
+
- Tables must include all required columns
|
|
61
|
+
- No placeholder text may remain in the final output
|
|
62
|
+
|
|
63
|
+
## Status
|
|
64
|
+
|
|
65
|
+
The status of the implementation plan must be clearly defined in the front matter and must reflect the current state of the plan. The status can be one of the following (status_color in brackets): `Completed` (bright green badge), `In progress` (yellow badge), `Planned` (blue badge), `Deprecated` (red badge), or `On Hold` (orange badge). It should also be displayed as a badge in the introduction section.
|
|
66
|
+
|
|
67
|
+
```md
|
|
68
|
+
---
|
|
69
|
+
goal: [Concise Title Describing the Package Implementation Plan's Goal]
|
|
70
|
+
version: [Optional: e.g., 1.0, Date]
|
|
71
|
+
date_created: [YYYY-MM-DD]
|
|
72
|
+
last_updated: [Optional: YYYY-MM-DD]
|
|
73
|
+
owner: [Optional: Team/Individual responsible for this spec]
|
|
74
|
+
status: 'Completed'|'In progress'|'Planned'|'Deprecated'|'On Hold'
|
|
75
|
+
tags: [Optional: List of relevant tags or categories, e.g., `feature`, `upgrade`, `chore`, `architecture`, `migration`, `bug` etc]
|
|
76
|
+
---
|
|
77
|
+
|
|
78
|
+
# Introduction
|
|
79
|
+
|
|
80
|
+

|
|
81
|
+
|
|
82
|
+
[A short concise introduction to the plan and the goal it is intended to achieve.]
|
|
83
|
+
|
|
84
|
+
## 1. Requirements & Constraints
|
|
85
|
+
|
|
86
|
+
[Explicitly list all requirements & constraints that affect the plan and constrain how it is implemented. Use bullet points or tables for clarity.]
|
|
87
|
+
|
|
88
|
+
- **REQ-001**: Requirement 1
|
|
89
|
+
- **SEC-001**: Security Requirement 1
|
|
90
|
+
- **[3 LETTERS]-001**: Other Requirement 1
|
|
91
|
+
- **CON-001**: Constraint 1
|
|
92
|
+
- **GUD-001**: Guideline 1
|
|
93
|
+
- **PAT-001**: Pattern to follow 1
|
|
94
|
+
|
|
95
|
+
## 2. Implementation Steps
|
|
96
|
+
|
|
97
|
+
### Implementation Phase 1
|
|
98
|
+
|
|
99
|
+
- GOAL-001: [Describe the goal of this phase, e.g., "Implement feature X", "Refactor module Y", etc.]
|
|
100
|
+
|
|
101
|
+
| Task | Description | Completed | Date |
|
|
102
|
+
|------|-------------|-----------|------|
|
|
103
|
+
| TASK-001 | Description of task 1 | ✅ | 2025-04-25 |
|
|
104
|
+
| TASK-002 | Description of task 2 | | |
|
|
105
|
+
| TASK-003 | Description of task 3 | | |
|
|
106
|
+
|
|
107
|
+
### Implementation Phase 2
|
|
108
|
+
|
|
109
|
+
- GOAL-002: [Describe the goal of this phase, e.g., "Implement feature X", "Refactor module Y", etc.]
|
|
110
|
+
|
|
111
|
+
| Task | Description | Completed | Date |
|
|
112
|
+
|------|-------------|-----------|------|
|
|
113
|
+
| TASK-004 | Description of task 4 | | |
|
|
114
|
+
| TASK-005 | Description of task 5 | | |
|
|
115
|
+
| TASK-006 | Description of task 6 | | |
|
|
116
|
+
|
|
117
|
+
## 3. Alternatives
|
|
118
|
+
|
|
119
|
+
[A bullet point list of any alternative approaches that were considered and why they were not chosen. This helps to provide context and rationale for the chosen approach.]
|
|
120
|
+
|
|
121
|
+
- **ALT-001**: Alternative approach 1
|
|
122
|
+
- **ALT-002**: Alternative approach 2
|
|
123
|
+
|
|
124
|
+
## 4. Dependencies
|
|
125
|
+
|
|
126
|
+
[List any dependencies that need to be addressed, such as libraries, frameworks, or other components that the plan relies on.]
|
|
127
|
+
|
|
128
|
+
- **DEP-001**: Dependency 1
|
|
129
|
+
- **DEP-002**: Dependency 2
|
|
130
|
+
|
|
131
|
+
## 5. Files
|
|
132
|
+
|
|
133
|
+
[List the files that will be affected by the feature or refactoring task.]
|
|
134
|
+
|
|
135
|
+
- **FILE-001**: Description of file 1
|
|
136
|
+
- **FILE-002**: Description of file 2
|
|
137
|
+
|
|
138
|
+
## 6. Testing
|
|
139
|
+
|
|
140
|
+
[List the tests that need to be implemented to verify the feature or refactoring task.]
|
|
141
|
+
|
|
142
|
+
- **TEST-001**: Description of test 1
|
|
143
|
+
- **TEST-002**: Description of test 2
|
|
144
|
+
|
|
145
|
+
## 7. Risks & Assumptions
|
|
146
|
+
|
|
147
|
+
[List any risks or assumptions related to the implementation of the plan.]
|
|
148
|
+
|
|
149
|
+
- **RISK-001**: Risk 1
|
|
150
|
+
- **ASSUMPTION-001**: Assumption 1
|
|
151
|
+
|
|
152
|
+
## 8. Related Specifications / Further Reading
|
|
153
|
+
|
|
154
|
+
[Link to related spec 1]
|
|
155
|
+
[Link to relevant external documentation]
|
|
156
|
+
```
|
|
@@ -0,0 +1,209 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: 'Create an llms.txt file from scratch based on repository structure following the llms.txt specification at https://llmstxt.org/'
|
|
3
|
+
tools: ['changes', 'search/codebase', 'edit/editFiles', 'extensions', 'fetch', 'githubRepo', 'openSimpleBrowser', 'problems', 'runTasks', 'search', 'search/searchResults', 'runCommands/terminalLastCommand', 'runCommands/terminalSelection', 'testFailure', 'usages', 'vscodeAPI']
|
|
4
|
+
---
|
|
5
|
+
# Create LLMs.txt File from Repository Structure
|
|
6
|
+
|
|
7
|
+
Create a new `llms.txt` file from scratch in the root of the repository following the official llms.txt specification at https://llmstxt.org/. This file provides high-level guidance to large language models (LLMs) on where to find relevant content for understanding the repository's purpose and specifications.
|
|
8
|
+
|
|
9
|
+
## Primary Directive
|
|
10
|
+
|
|
11
|
+
Create a comprehensive `llms.txt` file that serves as an entry point for LLMs to understand and navigate the repository effectively. The file must comply with the llms.txt specification and be optimized for LLM consumption while remaining human-readable.
|
|
12
|
+
|
|
13
|
+
## Analysis and Planning Phase
|
|
14
|
+
|
|
15
|
+
Before creating the `llms.txt` file, you must complete a thorough analysis:
|
|
16
|
+
|
|
17
|
+
### Step 1: Review llms.txt Specification
|
|
18
|
+
|
|
19
|
+
- Review the official specification at https://llmstxt.org/ to ensure full compliance
|
|
20
|
+
- Understand the required format structure and guidelines
|
|
21
|
+
- Note the specific markdown structure requirements
|
|
22
|
+
|
|
23
|
+
### Step 2: Repository Structure Analysis
|
|
24
|
+
|
|
25
|
+
- Examine the complete repository structure using appropriate tools
|
|
26
|
+
- Identify the primary purpose and scope of the repository
|
|
27
|
+
- Catalog all important directories and their purposes
|
|
28
|
+
- List key files that would be valuable for LLM understanding
|
|
29
|
+
|
|
30
|
+
### Step 3: Content Discovery
|
|
31
|
+
|
|
32
|
+
- Identify README files and their locations
|
|
33
|
+
- Find documentation files (`.md` files in `/docs/`, `/spec/`, etc.)
|
|
34
|
+
- Locate specification files and their purposes
|
|
35
|
+
- Discover configuration files and their relevance
|
|
36
|
+
- Find example files and code samples
|
|
37
|
+
- Identify any existing documentation structure
|
|
38
|
+
|
|
39
|
+
### Step 4: Create Implementation Plan
|
|
40
|
+
|
|
41
|
+
Based on your analysis, create a structured plan that includes:
|
|
42
|
+
|
|
43
|
+
- Repository purpose and scope summary
|
|
44
|
+
- Priority-ordered list of essential files for LLM understanding
|
|
45
|
+
- Secondary files that provide additional context
|
|
46
|
+
- Organizational structure for the llms.txt file
|
|
47
|
+
|
|
48
|
+
## Implementation Requirements
|
|
49
|
+
|
|
50
|
+
### Format Compliance
|
|
51
|
+
|
|
52
|
+
The `llms.txt` file must follow this exact structure per the specification:
|
|
53
|
+
|
|
54
|
+
1. **H1 Header**: Single line with repository/project name (required)
|
|
55
|
+
2. **Blockquote Summary**: Brief description in blockquote format (optional but recommended)
|
|
56
|
+
3. **Additional Details**: Zero or more markdown sections without headings for context
|
|
57
|
+
4. **File List Sections**: Zero or more H2 sections containing markdown lists of links
|
|
58
|
+
|
|
59
|
+
### Content Requirements
|
|
60
|
+
|
|
61
|
+
#### Required Elements
|
|
62
|
+
|
|
63
|
+
- **Project Name**: Clear, descriptive title as H1
|
|
64
|
+
- **Summary**: Concise blockquote explaining the repository's purpose
|
|
65
|
+
- **Key Files**: Essential files organized by category (H2 sections)
|
|
66
|
+
|
|
67
|
+
#### File Link Format
|
|
68
|
+
|
|
69
|
+
Each file link must follow: `[descriptive-name](relative-url): optional description`
|
|
70
|
+
|
|
71
|
+
#### Section Organization
|
|
72
|
+
|
|
73
|
+
Organize files into logical H2 sections such as:
|
|
74
|
+
|
|
75
|
+
- **Documentation**: Core documentation files
|
|
76
|
+
- **Specifications**: Technical specifications and requirements
|
|
77
|
+
- **Examples**: Sample code and usage examples
|
|
78
|
+
- **Configuration**: Setup and configuration files
|
|
79
|
+
- **Optional**: Secondary files (special meaning - can be skipped for shorter context)
|
|
80
|
+
|
|
81
|
+
### Content Guidelines
|
|
82
|
+
|
|
83
|
+
#### Language and Style
|
|
84
|
+
|
|
85
|
+
- Use concise, clear, unambiguous language
|
|
86
|
+
- Avoid jargon without explanation
|
|
87
|
+
- Write for both human and LLM readers
|
|
88
|
+
- Be specific and informative in descriptions
|
|
89
|
+
|
|
90
|
+
#### File Selection Criteria
|
|
91
|
+
|
|
92
|
+
Include files that:
|
|
93
|
+
- Explain the repository's purpose and scope
|
|
94
|
+
- Provide essential technical documentation
|
|
95
|
+
- Show usage examples and patterns
|
|
96
|
+
- Define interfaces and specifications
|
|
97
|
+
- Contain configuration and setup instructions
|
|
98
|
+
|
|
99
|
+
Exclude files that:
|
|
100
|
+
- Are purely implementation details
|
|
101
|
+
- Contain redundant information
|
|
102
|
+
- Are build artifacts or generated content
|
|
103
|
+
- Are not relevant to understanding the project
|
|
104
|
+
|
|
105
|
+
## Execution Steps
|
|
106
|
+
|
|
107
|
+
### Step 1: Repository Analysis
|
|
108
|
+
|
|
109
|
+
1. Examine the repository structure completely
|
|
110
|
+
2. Read the main README.md to understand the project
|
|
111
|
+
3. Identify all documentation directories and files
|
|
112
|
+
4. Catalog specification files and their purposes
|
|
113
|
+
5. Find example files and configuration files
|
|
114
|
+
|
|
115
|
+
### Step 2: Content Planning
|
|
116
|
+
|
|
117
|
+
1. Determine the primary purpose statement
|
|
118
|
+
2. Write a concise summary for the blockquote
|
|
119
|
+
3. Group identified files into logical categories
|
|
120
|
+
4. Prioritize files by importance for LLM understanding
|
|
121
|
+
5. Create descriptions for each file link
|
|
122
|
+
|
|
123
|
+
### Step 3: File Creation
|
|
124
|
+
|
|
125
|
+
1. Create the `llms.txt` file in the repository root
|
|
126
|
+
2. Follow the exact format specification
|
|
127
|
+
3. Include all required sections
|
|
128
|
+
4. Use proper markdown formatting
|
|
129
|
+
5. Ensure all links are valid relative paths
|
|
130
|
+
|
|
131
|
+
### Step 4: Validation
|
|
132
|
+
1. Verify compliance with https://llmstxt.org/ specification
|
|
133
|
+
2. Check that all links are valid and accessible
|
|
134
|
+
3. Ensure the file serves as an effective LLM navigation tool
|
|
135
|
+
4. Confirm the file is both human and machine readable
|
|
136
|
+
|
|
137
|
+
## Quality Assurance
|
|
138
|
+
|
|
139
|
+
### Format Validation
|
|
140
|
+
|
|
141
|
+
- ✅ H1 header with project name
|
|
142
|
+
- ✅ Blockquote summary (if included)
|
|
143
|
+
- ✅ H2 sections for file lists
|
|
144
|
+
- ✅ Proper markdown link format
|
|
145
|
+
- ✅ No broken or invalid links
|
|
146
|
+
- ✅ Consistent formatting throughout
|
|
147
|
+
|
|
148
|
+
### Content Validation
|
|
149
|
+
|
|
150
|
+
- ✅ Clear, unambiguous language
|
|
151
|
+
- ✅ Comprehensive coverage of essential files
|
|
152
|
+
- ✅ Logical organization of content
|
|
153
|
+
- ✅ Appropriate file descriptions
|
|
154
|
+
- ✅ Serves as effective LLM navigation tool
|
|
155
|
+
|
|
156
|
+
### Specification Compliance
|
|
157
|
+
|
|
158
|
+
- ✅ Follows https://llmstxt.org/ format exactly
|
|
159
|
+
- ✅ Uses required markdown structure
|
|
160
|
+
- ✅ Implements optional sections appropriately
|
|
161
|
+
- ✅ File located at repository root (`/llms.txt`)
|
|
162
|
+
|
|
163
|
+
## Example Structure Template
|
|
164
|
+
|
|
165
|
+
```txt
|
|
166
|
+
# [Repository Name]
|
|
167
|
+
|
|
168
|
+
> [Concise description of the repository's purpose and scope]
|
|
169
|
+
|
|
170
|
+
[Optional additional context paragraphs without headings]
|
|
171
|
+
|
|
172
|
+
## Documentation
|
|
173
|
+
|
|
174
|
+
- [Main README](README.md): Primary project documentation and getting started guide
|
|
175
|
+
- [Contributing Guide](CONTRIBUTING.md): Guidelines for contributing to the project
|
|
176
|
+
- [Code of Conduct](CODE_OF_CONDUCT.md): Community guidelines and expectations
|
|
177
|
+
|
|
178
|
+
## Specifications
|
|
179
|
+
|
|
180
|
+
- [Technical Specification](spec/technical-spec.md): Detailed technical requirements and constraints
|
|
181
|
+
- [API Specification](spec/api-spec.md): Interface definitions and data contracts
|
|
182
|
+
|
|
183
|
+
## Examples
|
|
184
|
+
|
|
185
|
+
- [Basic Example](examples/basic-usage.md): Simple usage demonstration
|
|
186
|
+
- [Advanced Example](examples/advanced-usage.md): Complex implementation patterns
|
|
187
|
+
|
|
188
|
+
## Configuration
|
|
189
|
+
|
|
190
|
+
- [Setup Guide](docs/setup.md): Installation and configuration instructions
|
|
191
|
+
- [Deployment Guide](docs/deployment.md): Production deployment guidelines
|
|
192
|
+
|
|
193
|
+
## Optional
|
|
194
|
+
|
|
195
|
+
- [Architecture Documentation](docs/architecture.md): Detailed system architecture
|
|
196
|
+
- [Design Decisions](docs/decisions.md): Historical design decision records
|
|
197
|
+
```
|
|
198
|
+
|
|
199
|
+
## Success Criteria
|
|
200
|
+
|
|
201
|
+
The created `llms.txt` file should:
|
|
202
|
+
1. Enable LLMs to quickly understand the repository's purpose
|
|
203
|
+
2. Provide clear navigation to essential documentation
|
|
204
|
+
3. Follow the official llms.txt specification exactly
|
|
205
|
+
4. Be comprehensive yet concise
|
|
206
|
+
5. Serve both human and machine readers effectively
|
|
207
|
+
6. Include all critical files for project understanding
|
|
208
|
+
7. Use clear, unambiguous language throughout
|
|
209
|
+
8. Organize content logically for easy consumption
|
|
@@ -0,0 +1,126 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: 'Create a new specification file for the solution, optimized for Generative AI consumption.'
|
|
3
|
+
tools: ['changes', 'search/codebase', 'edit/editFiles', 'extensions', 'fetch', 'githubRepo', 'openSimpleBrowser', 'problems', 'runTasks', 'search', 'search/searchResults', 'runCommands/terminalLastCommand', 'runCommands/terminalSelection', 'testFailure', 'usages', 'vscodeAPI']
|
|
4
|
+
---
|
|
5
|
+
# Create Specification
|
|
6
|
+
|
|
7
|
+
Your goal is to create a new specification file for `${input:SpecPurpose}`.
|
|
8
|
+
|
|
9
|
+
The specification file must define the requirements, constraints, and interfaces for the solution components in a manner that is clear, unambiguous, and structured for effective use by Generative AIs. Follow established documentation standards and ensure the content is machine-readable and self-contained.
|
|
10
|
+
|
|
11
|
+
## Best Practices for AI-Ready Specifications
|
|
12
|
+
|
|
13
|
+
- Use precise, explicit, and unambiguous language.
|
|
14
|
+
- Clearly distinguish between requirements, constraints, and recommendations.
|
|
15
|
+
- Use structured formatting (headings, lists, tables) for easy parsing.
|
|
16
|
+
- Avoid idioms, metaphors, or context-dependent references.
|
|
17
|
+
- Define all acronyms and domain-specific terms.
|
|
18
|
+
- Include examples and edge cases where applicable.
|
|
19
|
+
- Ensure the document is self-contained and does not rely on external context.
|
|
20
|
+
|
|
21
|
+
The specification should be saved in the [/spec/](/spec/) directory and named according to the following convention: `spec-[a-z0-9-]+.md`, where the name should be descriptive of the specification's content and starting with the highlevel purpose, which is one of [schema, tool, data, infrastructure, process, architecture, or design].
|
|
22
|
+
|
|
23
|
+
The specification file must be formatted in well formed Markdown.
|
|
24
|
+
|
|
25
|
+
Specification files must follow the template below, ensuring that all sections are filled out appropriately. The front matter for the markdown should be structured correctly as per the example following:
|
|
26
|
+
|
|
27
|
+
```md
|
|
28
|
+
---
|
|
29
|
+
title: [Concise Title Describing the Specification's Focus]
|
|
30
|
+
version: [Optional: e.g., 1.0, Date]
|
|
31
|
+
date_created: [YYYY-MM-DD]
|
|
32
|
+
last_updated: [Optional: YYYY-MM-DD]
|
|
33
|
+
owner: [Optional: Team/Individual responsible for this spec]
|
|
34
|
+
tags: [Optional: List of relevant tags or categories, e.g., `infrastructure`, `process`, `design`, `app` etc]
|
|
35
|
+
---
|
|
36
|
+
|
|
37
|
+
# Introduction
|
|
38
|
+
|
|
39
|
+
[A short concise introduction to the specification and the goal it is intended to achieve.]
|
|
40
|
+
|
|
41
|
+
## 1. Purpose & Scope
|
|
42
|
+
|
|
43
|
+
[Provide a clear, concise description of the specification's purpose and the scope of its application. State the intended audience and any assumptions.]
|
|
44
|
+
|
|
45
|
+
## 2. Definitions
|
|
46
|
+
|
|
47
|
+
[List and define all acronyms, abbreviations, and domain-specific terms used in this specification.]
|
|
48
|
+
|
|
49
|
+
## 3. Requirements, Constraints & Guidelines
|
|
50
|
+
|
|
51
|
+
[Explicitly list all requirements, constraints, rules, and guidelines. Use bullet points or tables for clarity.]
|
|
52
|
+
|
|
53
|
+
- **REQ-001**: Requirement 1
|
|
54
|
+
- **SEC-001**: Security Requirement 1
|
|
55
|
+
- **[3 LETTERS]-001**: Other Requirement 1
|
|
56
|
+
- **CON-001**: Constraint 1
|
|
57
|
+
- **GUD-001**: Guideline 1
|
|
58
|
+
- **PAT-001**: Pattern to follow 1
|
|
59
|
+
|
|
60
|
+
## 4. Interfaces & Data Contracts
|
|
61
|
+
|
|
62
|
+
[Describe the interfaces, APIs, data contracts, or integration points. Use tables or code blocks for schemas and examples.]
|
|
63
|
+
|
|
64
|
+
## 5. Acceptance Criteria
|
|
65
|
+
|
|
66
|
+
[Define clear, testable acceptance criteria for each requirement using Given-When-Then format where appropriate.]
|
|
67
|
+
|
|
68
|
+
- **AC-001**: Given [context], When [action], Then [expected outcome]
|
|
69
|
+
- **AC-002**: The system shall [specific behavior] when [condition]
|
|
70
|
+
- **AC-003**: [Additional acceptance criteria as needed]
|
|
71
|
+
|
|
72
|
+
## 6. Test Automation Strategy
|
|
73
|
+
|
|
74
|
+
[Define the testing approach, frameworks, and automation requirements.]
|
|
75
|
+
|
|
76
|
+
- **Test Levels**: Unit, Integration, End-to-End
|
|
77
|
+
- **Frameworks**: MSTest, FluentAssertions, Moq (for .NET applications)
|
|
78
|
+
- **Test Data Management**: [approach for test data creation and cleanup]
|
|
79
|
+
- **CI/CD Integration**: [automated testing in GitHub Actions pipelines]
|
|
80
|
+
- **Coverage Requirements**: [minimum code coverage thresholds]
|
|
81
|
+
- **Performance Testing**: [approach for load and performance testing]
|
|
82
|
+
|
|
83
|
+
## 7. Rationale & Context
|
|
84
|
+
|
|
85
|
+
[Explain the reasoning behind the requirements, constraints, and guidelines. Provide context for design decisions.]
|
|
86
|
+
|
|
87
|
+
## 8. Dependencies & External Integrations
|
|
88
|
+
|
|
89
|
+
[Define the external systems, services, and architectural dependencies required for this specification. Focus on **what** is needed rather than **how** it's implemented. Avoid specific package or library versions unless they represent architectural constraints.]
|
|
90
|
+
|
|
91
|
+
### External Systems
|
|
92
|
+
- **EXT-001**: [External system name] - [Purpose and integration type]
|
|
93
|
+
|
|
94
|
+
### Third-Party Services
|
|
95
|
+
- **SVC-001**: [Service name] - [Required capabilities and SLA requirements]
|
|
96
|
+
|
|
97
|
+
### Infrastructure Dependencies
|
|
98
|
+
- **INF-001**: [Infrastructure component] - [Requirements and constraints]
|
|
99
|
+
|
|
100
|
+
### Data Dependencies
|
|
101
|
+
- **DAT-001**: [External data source] - [Format, frequency, and access requirements]
|
|
102
|
+
|
|
103
|
+
### Technology Platform Dependencies
|
|
104
|
+
- **PLT-001**: [Platform/runtime requirement] - [Version constraints and rationale]
|
|
105
|
+
|
|
106
|
+
### Compliance Dependencies
|
|
107
|
+
- **COM-001**: [Regulatory or compliance requirement] - [Impact on implementation]
|
|
108
|
+
|
|
109
|
+
**Note**: This section should focus on architectural and business dependencies, not specific package implementations. For example, specify "OAuth 2.0 authentication library" rather than "Microsoft.AspNetCore.Authentication.JwtBearer v6.0.1".
|
|
110
|
+
|
|
111
|
+
## 9. Examples & Edge Cases
|
|
112
|
+
|
|
113
|
+
```code
|
|
114
|
+
// Code snippet or data example demonstrating the correct application of the guidelines, including edge cases
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
## 10. Validation Criteria
|
|
118
|
+
|
|
119
|
+
[List the criteria or tests that must be satisfied for compliance with this specification.]
|
|
120
|
+
|
|
121
|
+
## 11. Related Specifications / Further Reading
|
|
122
|
+
|
|
123
|
+
[Link to related spec 1]
|
|
124
|
+
[Link to relevant external documentation]
|
|
125
|
+
|
|
126
|
+
```
|