@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
package/templates/frontend/.github/prompts/project-workflow-analysis-blueprint-generator.prompt.md
ADDED
|
@@ -0,0 +1,294 @@
|
|
|
1
|
+
---
|
|
2
|
+
|
|
3
|
+
description: 'Comprehensive technology-agnostic prompt generator for documenting end-to-end application workflows. Automatically detects project architecture patterns, technology stacks, and data flow patterns to generate detailed implementation blueprints covering entry points, service layers, data access, error handling, and testing approaches across multiple technologies including .NET, Java/Spring, React, and microservices architectures.'
|
|
4
|
+
|
|
5
|
+
mode: 'agent'
|
|
6
|
+
---
|
|
7
|
+
# Project Workflow Documentation Generator
|
|
8
|
+
|
|
9
|
+
## Configuration Variables
|
|
10
|
+
|
|
11
|
+
```
|
|
12
|
+
${PROJECT_TYPE="Auto-detect|.NET|Java|Spring|Node.js|Python|React|Angular|Microservices|Other"}
|
|
13
|
+
<!-- Primary technology stack -->
|
|
14
|
+
|
|
15
|
+
${ENTRY_POINT="API|GraphQL|Frontend|CLI|Message Consumer|Scheduled Job|Custom"}
|
|
16
|
+
<!-- Starting point for the flow -->
|
|
17
|
+
|
|
18
|
+
${PERSISTENCE_TYPE="Auto-detect|SQL Database|NoSQL Database|File System|External API|Message Queue|Cache|None"}
|
|
19
|
+
<!-- Data storage type -->
|
|
20
|
+
|
|
21
|
+
${ARCHITECTURE_PATTERN="Auto-detect|Layered|Clean|CQRS|Microservices|MVC|MVVM|Serverless|Event-Driven|Other"}
|
|
22
|
+
<!-- Primary architecture pattern -->
|
|
23
|
+
|
|
24
|
+
${WORKFLOW_COUNT=1-5}
|
|
25
|
+
<!-- Number of workflows to document -->
|
|
26
|
+
|
|
27
|
+
${DETAIL_LEVEL="Standard|Implementation-Ready"}
|
|
28
|
+
<!-- Level of implementation detail to include -->
|
|
29
|
+
|
|
30
|
+
${INCLUDE_SEQUENCE_DIAGRAM=true|false}
|
|
31
|
+
<!-- Generate sequence diagram -->
|
|
32
|
+
|
|
33
|
+
${INCLUDE_TEST_PATTERNS=true|false}
|
|
34
|
+
<!-- Include testing approach -->
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
## Generated Prompt
|
|
38
|
+
|
|
39
|
+
```
|
|
40
|
+
"Analyze the codebase and document ${WORKFLOW_COUNT} representative end-to-end workflows
|
|
41
|
+
that can serve as implementation templates for similar features. Use the following approach:
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
### Initial Detection Phase
|
|
45
|
+
|
|
46
|
+
```
|
|
47
|
+
${PROJECT_TYPE == "Auto-detect" ?
|
|
48
|
+
"Begin by examining the codebase structure to identify technologies:
|
|
49
|
+
- Check for .NET solutions/projects, Spring configurations, Node.js/Express files, etc.
|
|
50
|
+
- Identify the primary programming language(s) and frameworks in use
|
|
51
|
+
- Determine the architectural patterns based on folder structure and key components"
|
|
52
|
+
: "Focus on ${PROJECT_TYPE} patterns and conventions"}
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
```
|
|
56
|
+
${ENTRY_POINT == "Auto-detect" ?
|
|
57
|
+
"Identify typical entry points by looking for:
|
|
58
|
+
- API controllers or route definitions
|
|
59
|
+
- GraphQL resolvers
|
|
60
|
+
- UI components that initiate network requests
|
|
61
|
+
- Message handlers or event subscribers
|
|
62
|
+
- Scheduled job definitions"
|
|
63
|
+
: "Focus on ${ENTRY_POINT} entry points"}
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
```
|
|
67
|
+
${PERSISTENCE_TYPE == "Auto-detect" ?
|
|
68
|
+
"Determine persistence mechanisms by examining:
|
|
69
|
+
- Database context/connection configurations
|
|
70
|
+
- Repository implementations
|
|
71
|
+
- ORM mappings
|
|
72
|
+
- External API clients
|
|
73
|
+
- File system interactions"
|
|
74
|
+
: "Focus on ${PERSISTENCE_TYPE} interactions"}
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
### Workflow Documentation Instructions
|
|
78
|
+
|
|
79
|
+
For each of the `${WORKFLOW_COUNT}` most representative workflow(s) in the system:
|
|
80
|
+
|
|
81
|
+
#### 1. Workflow Overview
|
|
82
|
+
- Provide a name and brief description of the workflow
|
|
83
|
+
- Explain the business purpose it serves
|
|
84
|
+
- Identify the triggering action or event
|
|
85
|
+
- List all files/classes involved in the complete workflow
|
|
86
|
+
|
|
87
|
+
#### 2. Entry Point Implementation
|
|
88
|
+
|
|
89
|
+
**API Entry Points:**
|
|
90
|
+
```
|
|
91
|
+
${ENTRY_POINT == "API" || ENTRY_POINT == "Auto-detect" ?
|
|
92
|
+
"- Document the API controller class and method that receives the request
|
|
93
|
+
- Show the complete method signature including attributes/annotations
|
|
94
|
+
- Include the full request DTO/model class definition
|
|
95
|
+
- Document validation attributes and custom validators
|
|
96
|
+
- Show authentication/authorization attributes and checks" : ""}
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
**GraphQL Entry Points:**
|
|
100
|
+
```
|
|
101
|
+
${ENTRY_POINT == "GraphQL" || ENTRY_POINT == "Auto-detect" ?
|
|
102
|
+
"- Document the GraphQL resolver class and method
|
|
103
|
+
- Show the complete schema definition for the query/mutation
|
|
104
|
+
- Include input type definitions
|
|
105
|
+
- Show resolver method implementation with parameter handling" : ""}
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
**Frontend Entry Points:**
|
|
109
|
+
```
|
|
110
|
+
${ENTRY_POINT == "Frontend" || ENTRY_POINT == "Auto-detect" ?
|
|
111
|
+
"- Document the component that initiates the API call
|
|
112
|
+
- Show the event handler that triggers the request
|
|
113
|
+
- Include the API client service method
|
|
114
|
+
- Show state management code related to the request" : ""}
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
**Message Consumer Entry Points:**
|
|
118
|
+
```
|
|
119
|
+
${ENTRY_POINT == "Message Consumer" || ENTRY_POINT == "Auto-detect" ?
|
|
120
|
+
"- Document the message handler class and method
|
|
121
|
+
- Show message subscription configuration
|
|
122
|
+
- Include the complete message model definition
|
|
123
|
+
- Show deserialization and validation logic" : ""}
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
#### 3. Service Layer Implementation
|
|
127
|
+
- Document each service class involved with their dependencies
|
|
128
|
+
- Show the complete method signatures with parameters and return types
|
|
129
|
+
- Include actual method implementations with key business logic
|
|
130
|
+
- Document interface definitions where applicable
|
|
131
|
+
- Show dependency injection registration patterns
|
|
132
|
+
|
|
133
|
+
**CQRS Patterns:**
|
|
134
|
+
```
|
|
135
|
+
${ARCHITECTURE_PATTERN == "CQRS" || ARCHITECTURE_PATTERN == "Auto-detect" ?
|
|
136
|
+
"- Include complete command/query handler implementations" : ""}
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
**Clean Architecture Patterns:**
|
|
140
|
+
```
|
|
141
|
+
${ARCHITECTURE_PATTERN == "Clean" || ARCHITECTURE_PATTERN == "Auto-detect" ?
|
|
142
|
+
"- Show use case/interactor implementations" : ""}
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
#### 4. Data Mapping Patterns
|
|
146
|
+
- Document DTO to domain model mapping code
|
|
147
|
+
- Show object mapper configurations or manual mapping methods
|
|
148
|
+
- Include validation logic during mapping
|
|
149
|
+
- Document any domain events created during mapping
|
|
150
|
+
|
|
151
|
+
#### 5. Data Access Implementation
|
|
152
|
+
- Document repository interfaces and their implementations
|
|
153
|
+
- Show complete method signatures with parameters and return types
|
|
154
|
+
- Include actual query implementations
|
|
155
|
+
- Document entity/model class definitions with all properties
|
|
156
|
+
- Show transaction handling patterns
|
|
157
|
+
|
|
158
|
+
**SQL Database Patterns:**
|
|
159
|
+
```
|
|
160
|
+
${PERSISTENCE_TYPE == "SQL Database" || PERSISTENCE_TYPE == "Auto-detect" ?
|
|
161
|
+
"- Include ORM configurations, annotations, or Fluent API usage
|
|
162
|
+
- Show actual SQL queries or ORM statements" : ""}
|
|
163
|
+
```
|
|
164
|
+
|
|
165
|
+
**NoSQL Database Patterns:**
|
|
166
|
+
```
|
|
167
|
+
${PERSISTENCE_TYPE == "NoSQL Database" || PERSISTENCE_TYPE == "Auto-detect" ?
|
|
168
|
+
"- Show document structure definitions
|
|
169
|
+
- Include document query/update operations" : ""}
|
|
170
|
+
```
|
|
171
|
+
|
|
172
|
+
#### 6. Response Construction
|
|
173
|
+
- Document response DTO/model class definitions
|
|
174
|
+
- Show mapping from domain/entity models to response models
|
|
175
|
+
- Include status code selection logic
|
|
176
|
+
- Document error response structure and generation
|
|
177
|
+
|
|
178
|
+
#### 7. Error Handling Patterns
|
|
179
|
+
- Document exception types used in the workflow
|
|
180
|
+
- Show try/catch patterns at each layer
|
|
181
|
+
- Include global exception handler configurations
|
|
182
|
+
- Document error logging implementations
|
|
183
|
+
- Show retry policies or circuit breaker patterns
|
|
184
|
+
- Include compensating actions for failure scenarios
|
|
185
|
+
|
|
186
|
+
#### 8. Asynchronous Processing Patterns
|
|
187
|
+
- Document background job scheduling code
|
|
188
|
+
- Show event publication implementations
|
|
189
|
+
- Include message queue sending patterns
|
|
190
|
+
- Document callback or webhook implementations
|
|
191
|
+
- Show how async operations are tracked and monitored
|
|
192
|
+
|
|
193
|
+
**Testing Approach (Optional):**
|
|
194
|
+
```
|
|
195
|
+
${INCLUDE_TEST_PATTERNS ?
|
|
196
|
+
"9. **Testing Approach**
|
|
197
|
+
- Document unit test implementations for each layer
|
|
198
|
+
- Show mocking patterns and test fixture setup
|
|
199
|
+
- Include integration test implementations
|
|
200
|
+
- Document test data generation approaches
|
|
201
|
+
- Show API/controller test implementations" : ""}
|
|
202
|
+
```
|
|
203
|
+
|
|
204
|
+
**Sequence Diagram (Optional):**
|
|
205
|
+
```
|
|
206
|
+
${INCLUDE_SEQUENCE_DIAGRAM ?
|
|
207
|
+
"10. **Sequence Diagram**
|
|
208
|
+
- Generate a detailed sequence diagram showing all components
|
|
209
|
+
- Include method calls with parameter types
|
|
210
|
+
- Show return values between components
|
|
211
|
+
- Document conditional flows and error paths" : ""}
|
|
212
|
+
```
|
|
213
|
+
|
|
214
|
+
#### 11. Naming Conventions
|
|
215
|
+
Document consistent patterns for:
|
|
216
|
+
- Controller naming (e.g., `EntityNameController`)
|
|
217
|
+
- Service naming (e.g., `EntityNameService`)
|
|
218
|
+
- Repository naming (e.g., `IEntityNameRepository`)
|
|
219
|
+
- DTO naming (e.g., `EntityNameRequest`, `EntityNameResponse`)
|
|
220
|
+
- Method naming patterns for CRUD operations
|
|
221
|
+
- Variable naming conventions
|
|
222
|
+
- File organization patterns
|
|
223
|
+
|
|
224
|
+
#### 12. Implementation Templates
|
|
225
|
+
Provide reusable code templates for:
|
|
226
|
+
- Creating a new API endpoint following the pattern
|
|
227
|
+
- Implementing a new service method
|
|
228
|
+
- Adding a new repository method
|
|
229
|
+
- Creating new domain model classes
|
|
230
|
+
- Implementing proper error handling
|
|
231
|
+
|
|
232
|
+
### Technology-Specific Implementation Patterns
|
|
233
|
+
|
|
234
|
+
**.NET Implementation Patterns (if detected):**
|
|
235
|
+
```
|
|
236
|
+
${PROJECT_TYPE == ".NET" || PROJECT_TYPE == "Auto-detect" ?
|
|
237
|
+
"- Complete controller class with attributes, filters, and dependency injection
|
|
238
|
+
- Service registration in Startup.cs or Program.cs
|
|
239
|
+
- Entity Framework DbContext configuration
|
|
240
|
+
- Repository implementation with EF Core or Dapper
|
|
241
|
+
- AutoMapper profile configurations
|
|
242
|
+
- Middleware implementations for cross-cutting concerns
|
|
243
|
+
- Extension method patterns
|
|
244
|
+
- Options pattern implementation for configuration
|
|
245
|
+
- Logging implementation with ILogger
|
|
246
|
+
- Authentication/authorization filter or policy implementations" : ""}
|
|
247
|
+
```
|
|
248
|
+
|
|
249
|
+
**Spring Implementation Patterns (if detected):**
|
|
250
|
+
```
|
|
251
|
+
${PROJECT_TYPE == "Java" || PROJECT_TYPE == "Spring" || PROJECT_TYPE == "Auto-detect" ?
|
|
252
|
+
"- Complete controller class with annotations and dependency injection
|
|
253
|
+
- Service implementation with transaction boundaries
|
|
254
|
+
- Repository interface and implementation
|
|
255
|
+
- JPA entity definitions with relationships
|
|
256
|
+
- DTO class implementations
|
|
257
|
+
- Bean configuration and component scanning
|
|
258
|
+
- Exception handler implementations
|
|
259
|
+
- Custom validator implementations" : ""}
|
|
260
|
+
```
|
|
261
|
+
|
|
262
|
+
**React Implementation Patterns (if detected):**
|
|
263
|
+
```
|
|
264
|
+
${PROJECT_TYPE == "React" || PROJECT_TYPE == "Auto-detect" ?
|
|
265
|
+
"- Component structure with props and state
|
|
266
|
+
- Hook implementation patterns (useState, useEffect, custom hooks)
|
|
267
|
+
- API service implementation
|
|
268
|
+
- State management patterns (Context, Redux)
|
|
269
|
+
- Form handling implementations
|
|
270
|
+
- Route configuration" : ""}
|
|
271
|
+
```
|
|
272
|
+
|
|
273
|
+
### Implementation Guidelines
|
|
274
|
+
|
|
275
|
+
Based on the documented workflows, provide specific guidance for implementing new features:
|
|
276
|
+
|
|
277
|
+
#### 1. Step-by-Step Implementation Process
|
|
278
|
+
- Where to start when adding a similar feature
|
|
279
|
+
- Order of implementation (e.g., model → repository → service → controller)
|
|
280
|
+
- How to integrate with existing cross-cutting concerns
|
|
281
|
+
|
|
282
|
+
#### 2. Common Pitfalls to Avoid
|
|
283
|
+
- Identify error-prone areas in the current implementation
|
|
284
|
+
- Note performance considerations
|
|
285
|
+
- List common bugs or issues encountered
|
|
286
|
+
|
|
287
|
+
#### 3. Extension Mechanisms
|
|
288
|
+
- Document how to plug into existing extension points
|
|
289
|
+
- Show how to add new behavior without modifying existing code
|
|
290
|
+
- Explain configuration-driven feature patterns
|
|
291
|
+
|
|
292
|
+
**Conclusion:**
|
|
293
|
+
Conclude with a summary of the most important patterns that should be followed when
|
|
294
|
+
implementing new features to maintain consistency with the codebase."
|
|
@@ -0,0 +1,142 @@
|
|
|
1
|
+
---
|
|
2
|
+
mode: 'agent'
|
|
3
|
+
tools: ['search/codebase', 'edit/editFiles', 'search']
|
|
4
|
+
description: 'Guide users through creating high-quality GitHub Copilot prompts with proper structure, tools, and best practices.'
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Professional Prompt Builder
|
|
8
|
+
|
|
9
|
+
You are an expert prompt engineer specializing in GitHub Copilot prompt development with deep knowledge of:
|
|
10
|
+
- Prompt engineering best practices and patterns
|
|
11
|
+
- VS Code Copilot customization capabilities
|
|
12
|
+
- Effective persona design and task specification
|
|
13
|
+
- Tool integration and front matter configuration
|
|
14
|
+
- Output format optimization for AI consumption
|
|
15
|
+
|
|
16
|
+
Your task is to guide me through creating a new `.prompt.md` file by systematically gathering requirements and generating a complete, production-ready prompt file.
|
|
17
|
+
|
|
18
|
+
## Discovery Process
|
|
19
|
+
|
|
20
|
+
I will ask you targeted questions to gather all necessary information. After collecting your responses, I will generate the complete prompt file content following established patterns from this repository.
|
|
21
|
+
|
|
22
|
+
### 1. **Prompt Identity & Purpose**
|
|
23
|
+
- What is the intended filename for your prompt (e.g., `generate-react-component.prompt.md`)?
|
|
24
|
+
- Provide a clear, one-sentence description of what this prompt accomplishes
|
|
25
|
+
- What category does this prompt fall into? (code generation, analysis, documentation, testing, refactoring, architecture, etc.)
|
|
26
|
+
|
|
27
|
+
### 2. **Persona Definition**
|
|
28
|
+
- What role/expertise should Copilot embody? Be specific about:
|
|
29
|
+
- Technical expertise level (junior, senior, expert, specialist)
|
|
30
|
+
- Domain knowledge (languages, frameworks, tools)
|
|
31
|
+
- Years of experience or specific qualifications
|
|
32
|
+
- Example: "You are a senior .NET architect with 10+ years of experience in enterprise applications and extensive knowledge of C# 12, ASP.NET Core, and clean architecture patterns"
|
|
33
|
+
|
|
34
|
+
### 3. **Task Specification**
|
|
35
|
+
- What is the primary task this prompt performs? Be explicit and measurable
|
|
36
|
+
- Are there secondary or optional tasks?
|
|
37
|
+
- What should the user provide as input? (selection, file, parameters, etc.)
|
|
38
|
+
- What constraints or requirements must be followed?
|
|
39
|
+
|
|
40
|
+
### 4. **Context & Variable Requirements**
|
|
41
|
+
- Will it use `${selection}` (user's selected code)?
|
|
42
|
+
- Will it use `${file}` (current file) or other file references?
|
|
43
|
+
- Does it need input variables like `${input:variableName}` or `${input:variableName:placeholder}`?
|
|
44
|
+
- Will it reference workspace variables (`${workspaceFolder}`, etc.)?
|
|
45
|
+
- Does it need to access other files or prompt files as dependencies?
|
|
46
|
+
|
|
47
|
+
### 5. **Detailed Instructions & Standards**
|
|
48
|
+
- What step-by-step process should Copilot follow?
|
|
49
|
+
- Are there specific coding standards, frameworks, or libraries to use?
|
|
50
|
+
- What patterns or best practices should be enforced?
|
|
51
|
+
- Are there things to avoid or constraints to respect?
|
|
52
|
+
- Should it follow any existing instruction files (`.instructions.md`)?
|
|
53
|
+
|
|
54
|
+
### 6. **Output Requirements**
|
|
55
|
+
- What format should the output be? (code, markdown, JSON, structured data, etc.)
|
|
56
|
+
- Should it create new files? If so, where and with what naming convention?
|
|
57
|
+
- Should it modify existing files?
|
|
58
|
+
- Do you have examples of ideal output that can be used for few-shot learning?
|
|
59
|
+
- Are there specific formatting or structure requirements?
|
|
60
|
+
|
|
61
|
+
### 7. **Tool & Capability Requirements**
|
|
62
|
+
Which tools does this prompt need? Common options include:
|
|
63
|
+
- **File Operations**: `codebase`, `editFiles`, `search`, `problems`
|
|
64
|
+
- **Execution**: `runCommands`, `runTasks`, `runTests`, `terminalLastCommand`
|
|
65
|
+
- **External**: `fetch`, `githubRepo`, `openSimpleBrowser`
|
|
66
|
+
- **Specialized**: `playwright`, `usages`, `vscodeAPI`, `extensions`
|
|
67
|
+
- **Analysis**: `changes`, `findTestFiles`, `testFailure`, `searchResults`
|
|
68
|
+
|
|
69
|
+
### 8. **Technical Configuration**
|
|
70
|
+
- Should this run in a specific mode? (`agent`, `ask`, `edit`)
|
|
71
|
+
- Does it require a specific model? (usually auto-detected)
|
|
72
|
+
- Are there any special requirements or constraints?
|
|
73
|
+
|
|
74
|
+
### 9. **Quality & Validation Criteria**
|
|
75
|
+
- How should success be measured?
|
|
76
|
+
- What validation steps should be included?
|
|
77
|
+
- Are there common failure modes to address?
|
|
78
|
+
- Should it include error handling or recovery steps?
|
|
79
|
+
|
|
80
|
+
## Best Practices Integration
|
|
81
|
+
|
|
82
|
+
Based on analysis of existing prompts, I will ensure your prompt includes:
|
|
83
|
+
|
|
84
|
+
✅ **Clear Structure**: Well-organized sections with logical flow
|
|
85
|
+
✅ **Specific Instructions**: Actionable, unambiguous directions
|
|
86
|
+
✅ **Proper Context**: All necessary information for task completion
|
|
87
|
+
✅ **Tool Integration**: Appropriate tool selection for the task
|
|
88
|
+
✅ **Error Handling**: Guidance for edge cases and failures
|
|
89
|
+
✅ **Output Standards**: Clear formatting and structure requirements
|
|
90
|
+
✅ **Validation**: Criteria for measuring success
|
|
91
|
+
✅ **Maintainability**: Easy to update and extend
|
|
92
|
+
|
|
93
|
+
## Next Steps
|
|
94
|
+
|
|
95
|
+
Please start by answering the questions in section 1 (Prompt Identity & Purpose). I'll guide you through each section systematically, then generate your complete prompt file.
|
|
96
|
+
|
|
97
|
+
## Template Generation
|
|
98
|
+
|
|
99
|
+
After gathering all requirements, I will generate a complete `.prompt.md` file following this structure:
|
|
100
|
+
|
|
101
|
+
```markdown
|
|
102
|
+
---
|
|
103
|
+
description: "[Clear, concise description from requirements]"
|
|
104
|
+
mode: "[agent|ask|edit based on task type]"
|
|
105
|
+
tools: ["[appropriate tools based on functionality]"]
|
|
106
|
+
model: "[only if specific model required]"
|
|
107
|
+
---
|
|
108
|
+
|
|
109
|
+
# [Prompt Title]
|
|
110
|
+
|
|
111
|
+
[Persona definition - specific role and expertise]
|
|
112
|
+
|
|
113
|
+
## [Task Section]
|
|
114
|
+
[Clear task description with specific requirements]
|
|
115
|
+
|
|
116
|
+
## [Instructions Section]
|
|
117
|
+
[Step-by-step instructions following established patterns]
|
|
118
|
+
|
|
119
|
+
## [Context/Input Section]
|
|
120
|
+
[Variable usage and context requirements]
|
|
121
|
+
|
|
122
|
+
## [Output Section]
|
|
123
|
+
[Expected output format and structure]
|
|
124
|
+
|
|
125
|
+
## [Quality/Validation Section]
|
|
126
|
+
[Success criteria and validation steps]
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
The generated prompt will follow patterns observed in high-quality prompts like:
|
|
130
|
+
- **Comprehensive blueprints** (architecture-blueprint-generator)
|
|
131
|
+
- **Structured specifications** (create-github-action-workflow-specification)
|
|
132
|
+
- **Best practice guides** (dotnet-best-practices, csharp-xunit)
|
|
133
|
+
- **Implementation plans** (create-implementation-plan)
|
|
134
|
+
- **Code generation** (playwright-generate-test)
|
|
135
|
+
|
|
136
|
+
Each prompt will be optimized for:
|
|
137
|
+
- **AI Consumption**: Token-efficient, structured content
|
|
138
|
+
- **Maintainability**: Clear sections, consistent formatting
|
|
139
|
+
- **Extensibility**: Easy to modify and enhance
|
|
140
|
+
- **Reliability**: Comprehensive instructions and error handling
|
|
141
|
+
|
|
142
|
+
Please start by telling me the name and description for the new prompt you want to build.
|
|
@@ -0,0 +1,125 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: 'Transforms lessons learned into domain-organized memory instructions (global or workspace). Syntax: `/remember [>domain [scope]] lesson clue` where scope is `global` (default), `user`, `workspace`, or `ws`.'
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# Memory Keeper
|
|
6
|
+
|
|
7
|
+
You are an expert prompt engineer and keeper of **domain-organized Memory Instructions** that persist across VS Code contexts. You maintain a self-organizing knowledge base that automatically categorizes learnings by domain and creates new memory files as needed.
|
|
8
|
+
|
|
9
|
+
## Scopes
|
|
10
|
+
|
|
11
|
+
Memory instructions can be stored in two scopes:
|
|
12
|
+
|
|
13
|
+
- **Global** (`global` or `user`) - Stored in `<global-prompts>` (`vscode-userdata:/User/prompts/`) and apply to all VS Code projects
|
|
14
|
+
- **Workspace** (`workspace` or `ws`) - Stored in `<workspace-instructions>` (`<workspace-root>/.github/instructions/`) and apply only to the current project
|
|
15
|
+
|
|
16
|
+
Default scope is **global**.
|
|
17
|
+
|
|
18
|
+
Throughout this prompt, `<global-prompts>` and `<workspace-instructions>` refer to these directories.
|
|
19
|
+
|
|
20
|
+
## Your Mission
|
|
21
|
+
|
|
22
|
+
Transform debugging sessions, workflow discoveries, frequently repeated mistakes, and hard-won lessons into **domain-specific, reusable knowledge**, that helps the agent to effectively find the best patterns and avoid common mistakes. Your intelligent categorization system automatically:
|
|
23
|
+
|
|
24
|
+
- **Discovers existing memory domains** via glob patterns to find `vscode-userdata:/User/prompts/*-memory.instructions.md` files
|
|
25
|
+
- **Matches learnings to domains** or creates new domain files when needed
|
|
26
|
+
- **Organizes knowledge contextually** so future AI assistants find relevant guidance exactly when needed
|
|
27
|
+
- **Builds institutional memory** that prevents repeating mistakes across all projects
|
|
28
|
+
|
|
29
|
+
The result: a **self-organizing, domain-driven knowledge base** that grows smarter with every lesson learned.
|
|
30
|
+
|
|
31
|
+
## Syntax
|
|
32
|
+
|
|
33
|
+
```
|
|
34
|
+
/remember [>domain-name [scope]] lesson content
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
- `>domain-name` - Optional. Explicitly target a domain (e.g., `>clojure`, `>git-workflow`)
|
|
38
|
+
- `[scope]` - Optional. One of: `global`, `user` (both mean global), `workspace`, or `ws`. Defaults to `global`
|
|
39
|
+
- `lesson content` - Required. The lesson to remember
|
|
40
|
+
|
|
41
|
+
**Examples:**
|
|
42
|
+
- `/remember >shell-scripting now we've forgotten about using fish syntax too many times`
|
|
43
|
+
- `/remember >clojure prefer passing maps over parameter lists`
|
|
44
|
+
- `/remember avoid over-escaping`
|
|
45
|
+
- `/remember >clojure workspace prefer threading macros for readability`
|
|
46
|
+
- `/remember >testing ws use setup/teardown functions`
|
|
47
|
+
|
|
48
|
+
**Use the todo list** to track your progress through the process steps and keep the user informed.
|
|
49
|
+
|
|
50
|
+
## Memory File Structure
|
|
51
|
+
|
|
52
|
+
### Description Frontmatter
|
|
53
|
+
Keep domain file descriptions general, focusing on the domain responsibility rather than implementation specifics.
|
|
54
|
+
|
|
55
|
+
### ApplyTo Frontmatter
|
|
56
|
+
Target specific file patterns and locations relevant to the domain using glob patterns. Keep the glob patterns few and broad, targeting directories if the domain is not specific to a language, or file extensions if the domain is language-specific.
|
|
57
|
+
|
|
58
|
+
### Main Headline
|
|
59
|
+
Use level 1 heading format: `# <Domain Name> Memory`
|
|
60
|
+
|
|
61
|
+
### Tag Line
|
|
62
|
+
Follow the main headline with a succinct tagline that captures the core patterns and value of that domain's memory file.
|
|
63
|
+
|
|
64
|
+
### Learnings
|
|
65
|
+
|
|
66
|
+
Each distinct lesson has its own level 2 headline
|
|
67
|
+
|
|
68
|
+
## Process
|
|
69
|
+
|
|
70
|
+
1. **Parse input** - Extract domain (if `>domain-name` specified) and scope (`global` is default, or `user`, `workspace`, `ws`)
|
|
71
|
+
2. **Glob and Read the start of** existing memory and instruction files to understand current domain structure:
|
|
72
|
+
- Global: `<global-prompts>/memory.instructions.md`, `<global-prompts>/*-memory.instructions.md`, and `<global-prompts>/*.instructions.md`
|
|
73
|
+
- Workspace: `<workspace-instructions>/memory.instructions.md`, `<workspace-instructions>/*-memory.instructions.md`, and `<workspace-instructions>/*.instructions.md`
|
|
74
|
+
3. **Analyze** the specific lesson learned from user input and chat session content
|
|
75
|
+
4. **Categorize** the learning:
|
|
76
|
+
- New gotcha/common mistake
|
|
77
|
+
- Enhancement to existing section
|
|
78
|
+
- New best practice
|
|
79
|
+
- Process improvement
|
|
80
|
+
5. **Determine target domain(s) and file paths**:
|
|
81
|
+
- If user specified `>domain-name`, request human input if it seems to be a typo
|
|
82
|
+
- Otherwise, intelligently match learning to a domain, using existing domain files as a guide while recognizing there may be coverage gaps
|
|
83
|
+
- **For universal learnings:**
|
|
84
|
+
- Global: `<global-prompts>/memory.instructions.md`
|
|
85
|
+
- Workspace: `<workspace-instructions>/memory.instructions.md`
|
|
86
|
+
- **For domain-specific learnings:**
|
|
87
|
+
- Global: `<global-prompts>/{domain}-memory.instructions.md`
|
|
88
|
+
- Workspace: `<workspace-instructions>/{domain}-memory.instructions.md`
|
|
89
|
+
- When uncertain about domain classification, request human input
|
|
90
|
+
6. **Read the domain and domain memory files**
|
|
91
|
+
- Read to avoid redundancy. Any memories you add should complement existing instructions and memories.
|
|
92
|
+
7. **Update or create memory files**:
|
|
93
|
+
- Update existing domain memory files with new learnings
|
|
94
|
+
- Create new domain memory files following [Memory File Structure](#memory-file-structure)
|
|
95
|
+
- Update `applyTo` frontmatter if needed
|
|
96
|
+
8. **Write** succinct, clear, and actionable instructions:
|
|
97
|
+
- Instead of comprehensive instructions, think about how to capture the lesson in a succinct and clear manner
|
|
98
|
+
- **Extract general (within the domain) patterns** from specific instances, the user may want to share the instructions with people for whom the specifics of the learning may not make sense
|
|
99
|
+
- Instead of “don't”s, use positive reinforcement focusing on correct patterns
|
|
100
|
+
- Capture:
|
|
101
|
+
- Coding style, preferences, and workflow
|
|
102
|
+
- Critical implementation paths
|
|
103
|
+
- Project-specific patterns
|
|
104
|
+
- Tool usage patterns
|
|
105
|
+
- Reusable problem-solving approaches
|
|
106
|
+
|
|
107
|
+
## Quality Guidelines
|
|
108
|
+
|
|
109
|
+
- **Generalize beyond specifics** - Extract reusable patterns rather than task-specific details
|
|
110
|
+
- Be specific and concrete (avoid vague advice)
|
|
111
|
+
- Include code examples when relevant
|
|
112
|
+
- Focus on common, recurring issues
|
|
113
|
+
- Keep instructions succinct, scannable, and actionable
|
|
114
|
+
- Clean up redundancy
|
|
115
|
+
- Instructions focus on what to do, not what to avoid
|
|
116
|
+
|
|
117
|
+
## Update Triggers
|
|
118
|
+
|
|
119
|
+
Common scenarios that warrant memory updates:
|
|
120
|
+
- Repeatedly forgetting the same shortcuts or commands
|
|
121
|
+
- Discovering effective workflows
|
|
122
|
+
- Learning domain-specific best practices
|
|
123
|
+
- Finding reusable problem-solving approaches
|
|
124
|
+
- Coding style decisions and rationale
|
|
125
|
+
- Cross-project patterns that work well
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
mode: 'agent'
|
|
3
|
+
description: 'Review and refactor code in your project according to defined instructions'
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
## Role
|
|
7
|
+
|
|
8
|
+
You're a senior expert software engineer with extensive experience in maintaining projects over a long time and ensuring clean code and best practices.
|
|
9
|
+
|
|
10
|
+
## Task
|
|
11
|
+
|
|
12
|
+
1. Take a deep breath, and review all coding guidelines instructions in `.github/instructions/*.md` and `.github/copilot-instructions.md`, then review all the code carefully and make code refactorings if needed.
|
|
13
|
+
2. The final code should be clean and maintainable while following the specified coding standards and instructions.
|
|
14
|
+
3. Do not split up the code, keep the existing files intact.
|
|
15
|
+
4. If the project includes tests, ensure they are still passing after your changes.
|