workspace-architect 1.3.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/.env.example +1 -0
- package/.gitattributes +1 -0
- package/.github/workflows/manual-publish.yml +36 -0
- package/.github/workflows/sync-and-publish.yml +58 -0
- package/.release-it.json +20 -0
- package/CHANGELOG.md +43 -0
- package/README.md +62 -0
- package/assets/chatmodes/4.1-Beast.chatmode.md +152 -0
- package/assets/chatmodes/Thinking-Beast-Mode.chatmode.md +337 -0
- package/assets/chatmodes/Ultimate-Transparent-Thinking-Beast-Mode.chatmode.md +644 -0
- package/assets/chatmodes/accessibility.chatmode.md +298 -0
- package/assets/chatmodes/address-comments.chatmode.md +59 -0
- package/assets/chatmodes/aem-frontend-specialist.chatmode.md +385 -0
- package/assets/chatmodes/api-architect.chatmode.md +40 -0
- package/assets/chatmodes/atlassian-requirements-to-jira.chatmode.md +444 -0
- package/assets/chatmodes/azure-logic-apps-expert.chatmode.md +100 -0
- package/assets/chatmodes/azure-principal-architect.chatmode.md +58 -0
- package/assets/chatmodes/azure-saas-architect.chatmode.md +118 -0
- package/assets/chatmodes/azure-verified-modules-bicep.chatmode.md +44 -0
- package/assets/chatmodes/azure-verified-modules-terraform.chatmode.md +58 -0
- package/assets/chatmodes/bicep-implement.chatmode.md +40 -0
- package/assets/chatmodes/bicep-plan.chatmode.md +112 -0
- package/assets/chatmodes/blueprint-mode-codex.chatmode.md +110 -0
- package/assets/chatmodes/blueprint-mode.chatmode.md +171 -0
- package/assets/chatmodes/clojure-interactive-programming.chatmode.md +174 -0
- package/assets/chatmodes/code-tour.chatmode.md +205 -0
- package/assets/chatmodes/critical-thinking.chatmode.md +23 -0
- package/assets/chatmodes/csharp-dotnet-janitor.chatmode.md +83 -0
- package/assets/chatmodes/csharp-mcp-expert.chatmode.md +69 -0
- package/assets/chatmodes/debug.chatmode.md +79 -0
- package/assets/chatmodes/declarative-agents-architect.chatmode.md +76 -0
- package/assets/chatmodes/demonstrate-understanding.chatmode.md +60 -0
- package/assets/chatmodes/dotnet-upgrade.chatmode.md +222 -0
- package/assets/chatmodes/drupal-expert.chatmode.md +687 -0
- package/assets/chatmodes/electron-angular-native.chatmode.md +285 -0
- package/assets/chatmodes/expert-cpp-software-engineer.chatmode.md +27 -0
- package/assets/chatmodes/expert-dotnet-software-engineer.chatmode.md +22 -0
- package/assets/chatmodes/expert-nextjs-developer.chatmode.md +477 -0
- package/assets/chatmodes/expert-react-frontend-engineer.chatmode.md +738 -0
- package/assets/chatmodes/gilfoyle.chatmode.md +66 -0
- package/assets/chatmodes/go-mcp-expert.chatmode.md +122 -0
- package/assets/chatmodes/gpt-5-beast-mode.chatmode.md +109 -0
- package/assets/chatmodes/hlbpa.chatmode.md +232 -0
- package/assets/chatmodes/implementation-plan.chatmode.md +159 -0
- package/assets/chatmodes/janitor.chatmode.md +89 -0
- package/assets/chatmodes/java-mcp-expert.chatmode.md +325 -0
- package/assets/chatmodes/kotlin-mcp-expert.chatmode.md +181 -0
- package/assets/chatmodes/kusto-assistant.chatmode.md +143 -0
- package/assets/chatmodes/laravel-expert-agent.chatmode.md +628 -0
- package/assets/chatmodes/mentor.chatmode.md +32 -0
- package/assets/chatmodes/meta-agentic-project-scaffold.chatmode.md +15 -0
- package/assets/chatmodes/microsoft-agent-framework-dotnet.chatmode.md +62 -0
- package/assets/chatmodes/microsoft-agent-framework-python.chatmode.md +62 -0
- package/assets/chatmodes/microsoft-study-mode.chatmode.md +32 -0
- package/assets/chatmodes/microsoft_learn_contributor.chatmode.md +388 -0
- package/assets/chatmodes/ms-sql-dba.chatmode.md +25 -0
- package/assets/chatmodes/php-mcp-expert.chatmode.md +498 -0
- package/assets/chatmodes/pimcore-expert.chatmode.md +869 -0
- package/assets/chatmodes/plan.chatmode.md +114 -0
- package/assets/chatmodes/planner.chatmode.md +14 -0
- package/assets/chatmodes/playwright-tester.chatmode.md +13 -0
- package/assets/chatmodes/postgresql-dba.chatmode.md +17 -0
- package/assets/chatmodes/power-bi-data-modeling-expert.chatmode.md +319 -0
- package/assets/chatmodes/power-bi-dax-expert.chatmode.md +334 -0
- package/assets/chatmodes/power-bi-performance-expert.chatmode.md +533 -0
- package/assets/chatmodes/power-bi-visualization-expert.chatmode.md +549 -0
- package/assets/chatmodes/power-platform-expert.chatmode.md +116 -0
- package/assets/chatmodes/power-platform-mcp-integration-expert.chatmode.md +149 -0
- package/assets/chatmodes/prd.chatmode.md +201 -0
- package/assets/chatmodes/principal-software-engineer.chatmode.md +41 -0
- package/assets/chatmodes/prompt-builder.chatmode.md +352 -0
- package/assets/chatmodes/prompt-engineer.chatmode.md +72 -0
- package/assets/chatmodes/python-mcp-expert.chatmode.md +99 -0
- package/assets/chatmodes/refine-issue.chatmode.md +34 -0
- package/assets/chatmodes/research-technical-spike.chatmode.md +169 -0
- package/assets/chatmodes/ruby-mcp-expert.chatmode.md +346 -0
- package/assets/chatmodes/rust-gpt-4.1-beast-mode.chatmode.md +197 -0
- package/assets/chatmodes/rust-mcp-expert.chatmode.md +465 -0
- package/assets/chatmodes/search-ai-optimization-expert.chatmode.md +227 -0
- package/assets/chatmodes/semantic-kernel-dotnet.chatmode.md +31 -0
- package/assets/chatmodes/semantic-kernel-python.chatmode.md +28 -0
- package/assets/chatmodes/shopify-expert.chatmode.md +681 -0
- package/assets/chatmodes/simple-app-idea-generator.chatmode.md +134 -0
- package/assets/chatmodes/software-engineer-agent-v1.chatmode.md +164 -0
- package/assets/chatmodes/specification.chatmode.md +127 -0
- package/assets/chatmodes/swift-mcp-expert.chatmode.md +240 -0
- package/assets/chatmodes/task-planner.chatmode.md +374 -0
- package/assets/chatmodes/task-researcher.chatmode.md +254 -0
- package/assets/chatmodes/tdd-green.chatmode.md +59 -0
- package/assets/chatmodes/tdd-red.chatmode.md +59 -0
- package/assets/chatmodes/tdd-refactor.chatmode.md +84 -0
- package/assets/chatmodes/tech-debt-remediation-plan.chatmode.md +49 -0
- package/assets/chatmodes/terraform-azure-implement.chatmode.md +104 -0
- package/assets/chatmodes/terraform-azure-planning.chatmode.md +157 -0
- package/assets/chatmodes/typescript-mcp-expert.chatmode.md +91 -0
- package/assets/chatmodes/voidbeast-gpt41enhanced.chatmode.md +230 -0
- package/assets/chatmodes/wg-code-alchemist.chatmode.md +61 -0
- package/assets/chatmodes/wg-code-sentinel.chatmode.md +55 -0
- package/assets/collections/ai-prompt-engineering.json +18 -0
- package/assets/collections/angular-development.json +7 -0
- package/assets/collections/azure-cloud-architect.json +29 -0
- package/assets/collections/cpp-development.json +6 -0
- package/assets/collections/database-administration.json +8 -0
- package/assets/collections/devops-sre.json +11 -0
- package/assets/collections/dotnet-development.json +22 -0
- package/assets/collections/general-productivity.json +9 -0
- package/assets/collections/go-development.json +7 -0
- package/assets/collections/java-spring-developer.json +26 -0
- package/assets/collections/learning-mentoring.json +10 -0
- package/assets/collections/legacy-migration.json +4 -0
- package/assets/collections/mcp-specialist.json +41 -0
- package/assets/collections/mobile-development.json +4 -0
- package/assets/collections/php-cms-development.json +11 -0
- package/assets/collections/power-platform-specialist.json +31 -0
- package/assets/collections/project-management.json +12 -0
- package/assets/collections/python-development.json +13 -0
- package/assets/collections/quality-assurance.json +13 -0
- package/assets/collections/ruby-development.json +9 -0
- package/assets/collections/rust-development.json +10 -0
- package/assets/collections/security-specialist.json +8 -0
- package/assets/collections/software-architect.json +25 -0
- package/assets/collections/technical-writing.json +9 -0
- package/assets/collections/web-frontend-development.json +14 -0
- package/assets/instructions/a11y.instructions.md +369 -0
- package/assets/instructions/ai-prompt-engineering-safety-best-practices.instructions.md +867 -0
- package/assets/instructions/angular.instructions.md +104 -0
- package/assets/instructions/ansible.instructions.md +88 -0
- package/assets/instructions/aspnet-rest-apis.instructions.md +110 -0
- package/assets/instructions/astro.instructions.md +182 -0
- package/assets/instructions/azure-devops-pipelines.instructions.md +185 -0
- package/assets/instructions/azure-functions-typescript.instructions.md +14 -0
- package/assets/instructions/azure-logic-apps-power-automate.instructions.md +1943 -0
- package/assets/instructions/azure-verified-modules-terraform.instructions.md +229 -0
- package/assets/instructions/bicep-code-best-practices.instructions.md +54 -0
- package/assets/instructions/blazor.instructions.md +77 -0
- package/assets/instructions/clojure.instructions.md +349 -0
- package/assets/instructions/cmake-vcpkg.instructions.md +10 -0
- package/assets/instructions/codexer.instructions.md +428 -0
- package/assets/instructions/coldfusion-cfc.instructions.md +30 -0
- package/assets/instructions/coldfusion-cfm.instructions.md +28 -0
- package/assets/instructions/collections.instructions.md +54 -0
- package/assets/instructions/containerization-docker-best-practices.instructions.md +681 -0
- package/assets/instructions/convert-jpa-to-spring-data-cosmos.instructions.md +949 -0
- package/assets/instructions/copilot-thought-logging.instructions.md +62 -0
- package/assets/instructions/csharp-ja.instructions.md +114 -0
- package/assets/instructions/csharp-ko.instructions.md +77 -0
- package/assets/instructions/csharp-mcp-server.instructions.md +95 -0
- package/assets/instructions/csharp.instructions.md +114 -0
- package/assets/instructions/dart-n-flutter.instructions.md +447 -0
- package/assets/instructions/declarative-agents-microsoft365.instructions.md +316 -0
- package/assets/instructions/devbox-image-definition.instructions.md +302 -0
- package/assets/instructions/devops-core-principles.instructions.md +167 -0
- package/assets/instructions/dotnet-architecture-good-practices.instructions.md +279 -0
- package/assets/instructions/dotnet-framework.instructions.md +113 -0
- package/assets/instructions/dotnet-maui-9-to-dotnet-maui-10-upgrade.instructions.md +1922 -0
- package/assets/instructions/dotnet-maui.instructions.md +69 -0
- package/assets/instructions/dotnet-upgrade.instructions.md +287 -0
- package/assets/instructions/dotnet-wpf.instructions.md +79 -0
- package/assets/instructions/genaiscript.instructions.md +21 -0
- package/assets/instructions/generate-modern-terraform-code-for-azure.instructions.md +82 -0
- package/assets/instructions/gilfoyle-code-review.instructions.md +114 -0
- package/assets/instructions/github-actions-ci-cd-best-practices.instructions.md +607 -0
- package/assets/instructions/go-mcp-server.instructions.md +346 -0
- package/assets/instructions/go.instructions.md +373 -0
- package/assets/instructions/instructions.instructions.md +256 -0
- package/assets/instructions/java-11-to-java-17-upgrade.instructions.md +793 -0
- package/assets/instructions/java-17-to-java-21-upgrade.instructions.md +464 -0
- package/assets/instructions/java-21-to-java-25-upgrade.instructions.md +311 -0
- package/assets/instructions/java-mcp-server.instructions.md +553 -0
- package/assets/instructions/java.instructions.md +81 -0
- package/assets/instructions/joyride-user-project.instructions.md +206 -0
- package/assets/instructions/joyride-workspace-automation.instructions.md +46 -0
- package/assets/instructions/kotlin-mcp-server.instructions.md +481 -0
- package/assets/instructions/kubernetes-deployment-best-practices.instructions.md +307 -0
- package/assets/instructions/langchain-python.instructions.md +229 -0
- package/assets/instructions/localization.instructions.md +39 -0
- package/assets/instructions/makefile.instructions.md +410 -0
- package/assets/instructions/markdown.instructions.md +52 -0
- package/assets/instructions/memory-bank.instructions.md +299 -0
- package/assets/instructions/mongo-dba.instructions.md +25 -0
- package/assets/instructions/ms-sql-dba.instructions.md +25 -0
- package/assets/instructions/nestjs.instructions.md +406 -0
- package/assets/instructions/nextjs-tailwind.instructions.md +72 -0
- package/assets/instructions/nextjs.instructions.md +143 -0
- package/assets/instructions/nodejs-javascript-vitest.instructions.md +30 -0
- package/assets/instructions/object-calisthenics.instructions.md +302 -0
- package/assets/instructions/oqtane.instructions.md +86 -0
- package/assets/instructions/performance-optimization.instructions.md +420 -0
- package/assets/instructions/php-mcp-server.instructions.md +809 -0
- package/assets/instructions/playwright-dotnet.instructions.md +101 -0
- package/assets/instructions/playwright-python.instructions.md +62 -0
- package/assets/instructions/playwright-typescript.instructions.md +86 -0
- package/assets/instructions/power-apps-canvas-yaml.instructions.md +827 -0
- package/assets/instructions/power-apps-code-apps.instructions.md +601 -0
- package/assets/instructions/power-bi-custom-visuals-development.instructions.md +810 -0
- package/assets/instructions/power-bi-data-modeling-best-practices.instructions.md +639 -0
- package/assets/instructions/power-bi-dax-best-practices.instructions.md +795 -0
- package/assets/instructions/power-bi-devops-alm-best-practices.instructions.md +623 -0
- package/assets/instructions/power-bi-report-design-best-practices.instructions.md +752 -0
- package/assets/instructions/power-bi-security-rls-best-practices.instructions.md +504 -0
- package/assets/instructions/power-platform-connector.instructions.md +430 -0
- package/assets/instructions/power-platform-mcp-development.instructions.md +88 -0
- package/assets/instructions/powershell-pester-5.instructions.md +197 -0
- package/assets/instructions/powershell.instructions.md +356 -0
- package/assets/instructions/prompt.instructions.md +73 -0
- package/assets/instructions/python-mcp-server.instructions.md +204 -0
- package/assets/instructions/python.instructions.md +56 -0
- package/assets/instructions/quarkus-mcp-server-sse.instructions.md +49 -0
- package/assets/instructions/quarkus.instructions.md +98 -0
- package/assets/instructions/r.instructions.md +116 -0
- package/assets/instructions/reactjs.instructions.md +162 -0
- package/assets/instructions/ruby-mcp-server.instructions.md +629 -0
- package/assets/instructions/ruby-on-rails.instructions.md +124 -0
- package/assets/instructions/rust-mcp-server.instructions.md +715 -0
- package/assets/instructions/rust.instructions.md +135 -0
- package/assets/instructions/security-and-owasp.instructions.md +51 -0
- package/assets/instructions/self-explanatory-code-commenting.instructions.md +162 -0
- package/assets/instructions/shell.instructions.md +132 -0
- package/assets/instructions/spec-driven-workflow-v1.instructions.md +323 -0
- package/assets/instructions/springboot.instructions.md +68 -0
- package/assets/instructions/sql-sp-generation.instructions.md +74 -0
- package/assets/instructions/svelte.instructions.md +161 -0
- package/assets/instructions/swift-mcp-server.instructions.md +498 -0
- package/assets/instructions/taming-copilot.instructions.md +40 -0
- package/assets/instructions/tanstack-start-shadcn-tailwind.instructions.md +212 -0
- package/assets/instructions/task-implementation.instructions.md +190 -0
- package/assets/instructions/tasksync.instructions.md +352 -0
- package/assets/instructions/terraform-azure.instructions.md +254 -0
- package/assets/instructions/terraform-sap-btp.instructions.md +195 -0
- package/assets/instructions/terraform.instructions.md +113 -0
- package/assets/instructions/typescript-5-es2022.instructions.md +114 -0
- package/assets/instructions/typescript-mcp-server.instructions.md +228 -0
- package/assets/instructions/update-code-from-shorthand.instructions.md +130 -0
- package/assets/instructions/vuejs3.instructions.md +153 -0
- package/assets/instructions/wordpress.instructions.md +186 -0
- package/assets/prompts/add-educational-comments.prompt.md +129 -0
- package/assets/prompts/ai-prompt-engineering-safety-review.prompt.md +230 -0
- package/assets/prompts/architecture-blueprint-generator.prompt.md +322 -0
- package/assets/prompts/aspnet-minimal-api-openapi.prompt.md +42 -0
- package/assets/prompts/az-cost-optimize.prompt.md +305 -0
- package/assets/prompts/azure-resource-health-diagnose.prompt.md +290 -0
- package/assets/prompts/boost-prompt.prompt.md +25 -0
- package/assets/prompts/breakdown-epic-arch.prompt.md +66 -0
- package/assets/prompts/breakdown-epic-pm.prompt.md +58 -0
- package/assets/prompts/breakdown-feature-implementation.prompt.md +128 -0
- package/assets/prompts/breakdown-feature-prd.prompt.md +61 -0
- package/assets/prompts/breakdown-plan.prompt.md +509 -0
- package/assets/prompts/breakdown-test.prompt.md +365 -0
- package/assets/prompts/code-exemplars-blueprint-generator.prompt.md +126 -0
- package/assets/prompts/comment-code-generate-a-tutorial.prompt.md +26 -0
- package/assets/prompts/containerize-aspnet-framework.prompt.md +455 -0
- package/assets/prompts/containerize-aspnetcore.prompt.md +393 -0
- package/assets/prompts/conventional-commit.prompt.md +73 -0
- package/assets/prompts/copilot-instructions-blueprint-generator.prompt.md +294 -0
- package/assets/prompts/cosmosdb-datamodeling.prompt.md +1045 -0
- package/assets/prompts/create-agentsmd.prompt.md +249 -0
- package/assets/prompts/create-architectural-decision-record.prompt.md +97 -0
- package/assets/prompts/create-github-action-workflow-specification.prompt.md +276 -0
- package/assets/prompts/create-github-issue-feature-from-specification.prompt.md +28 -0
- package/assets/prompts/create-github-issues-feature-from-implementation-plan.prompt.md +28 -0
- package/assets/prompts/create-github-issues-for-unmet-specification-requirements.prompt.md +35 -0
- package/assets/prompts/create-github-pull-request-from-specification.prompt.md +24 -0
- package/assets/prompts/create-implementation-plan.prompt.md +157 -0
- package/assets/prompts/create-llms.prompt.md +210 -0
- package/assets/prompts/create-oo-component-documentation.prompt.md +193 -0
- package/assets/prompts/create-readme.prompt.md +21 -0
- package/assets/prompts/create-specification.prompt.md +127 -0
- package/assets/prompts/create-spring-boot-java-project.prompt.md +163 -0
- package/assets/prompts/create-spring-boot-kotlin-project.prompt.md +147 -0
- package/assets/prompts/create-technical-spike.prompt.md +231 -0
- package/assets/prompts/csharp-async.prompt.md +50 -0
- package/assets/prompts/csharp-docs.prompt.md +63 -0
- package/assets/prompts/csharp-mcp-server-generator.prompt.md +59 -0
- package/assets/prompts/csharp-mstest.prompt.md +67 -0
- package/assets/prompts/csharp-nunit.prompt.md +72 -0
- package/assets/prompts/csharp-tunit.prompt.md +101 -0
- package/assets/prompts/csharp-xunit.prompt.md +69 -0
- package/assets/prompts/declarative-agents.prompt.md +93 -0
- package/assets/prompts/documentation-writer.prompt.md +46 -0
- package/assets/prompts/dotnet-best-practices.prompt.md +84 -0
- package/assets/prompts/dotnet-design-pattern-review.prompt.md +41 -0
- package/assets/prompts/dotnet-upgrade.prompt.md +116 -0
- package/assets/prompts/editorconfig.prompt.md +64 -0
- package/assets/prompts/ef-core.prompt.md +76 -0
- package/assets/prompts/finalize-agent-prompt.prompt.md +27 -0
- package/assets/prompts/first-ask.prompt.md +29 -0
- package/assets/prompts/folder-structure-blueprint-generator.prompt.md +405 -0
- package/assets/prompts/gen-specs-as-issues.prompt.md +165 -0
- package/assets/prompts/generate-custom-instructions-from-codebase.prompt.md +240 -0
- package/assets/prompts/git-flow-branch-creator.prompt.md +293 -0
- package/assets/prompts/github-copilot-starter.prompt.md +372 -0
- package/assets/prompts/go-mcp-server-generator.prompt.md +334 -0
- package/assets/prompts/java-docs.prompt.md +24 -0
- package/assets/prompts/java-junit.prompt.md +64 -0
- package/assets/prompts/java-mcp-server-generator.prompt.md +756 -0
- package/assets/prompts/java-refactoring-extract-method.prompt.md +105 -0
- package/assets/prompts/java-refactoring-remove-parameter.prompt.md +85 -0
- package/assets/prompts/java-springboot.prompt.md +66 -0
- package/assets/prompts/javascript-typescript-jest.prompt.md +44 -0
- package/assets/prompts/kotlin-mcp-server-generator.prompt.md +449 -0
- package/assets/prompts/kotlin-springboot.prompt.md +71 -0
- package/assets/prompts/mcp-copilot-studio-server-generator.prompt.md +118 -0
- package/assets/prompts/memory-merger.prompt.md +107 -0
- package/assets/prompts/mkdocs-translations.prompt.md +110 -0
- package/assets/prompts/model-recommendation.prompt.md +677 -0
- package/assets/prompts/multi-stage-dockerfile.prompt.md +47 -0
- package/assets/prompts/my-issues.prompt.md +9 -0
- package/assets/prompts/my-pull-requests.prompt.md +15 -0
- package/assets/prompts/next-intl-add-language.prompt.md +20 -0
- package/assets/prompts/php-mcp-server-generator.prompt.md +522 -0
- package/assets/prompts/playwright-automation-fill-in-form.prompt.md +30 -0
- package/assets/prompts/playwright-explore-website.prompt.md +19 -0
- package/assets/prompts/playwright-generate-test.prompt.md +19 -0
- package/assets/prompts/postgresql-code-review.prompt.md +214 -0
- package/assets/prompts/postgresql-optimization.prompt.md +406 -0
- package/assets/prompts/power-apps-code-app-scaffold.prompt.md +150 -0
- package/assets/prompts/power-bi-dax-optimization.prompt.md +175 -0
- package/assets/prompts/power-bi-model-design-review.prompt.md +405 -0
- package/assets/prompts/power-bi-performance-troubleshooting.prompt.md +384 -0
- package/assets/prompts/power-bi-report-design-consultation.prompt.md +353 -0
- package/assets/prompts/power-platform-mcp-connector-suite.prompt.md +156 -0
- package/assets/prompts/project-workflow-analysis-blueprint-generator.prompt.md +294 -0
- package/assets/prompts/prompt-builder.prompt.md +142 -0
- package/assets/prompts/pytest-coverage.prompt.md +28 -0
- package/assets/prompts/python-mcp-server-generator.prompt.md +105 -0
- package/assets/prompts/readme-blueprint-generator.prompt.md +79 -0
- package/assets/prompts/remember-interactive-programming.prompt.md +13 -0
- package/assets/prompts/remember.prompt.md +125 -0
- package/assets/prompts/repo-story-time.prompt.md +156 -0
- package/assets/prompts/review-and-refactor.prompt.md +15 -0
- package/assets/prompts/ruby-mcp-server-generator.prompt.md +660 -0
- package/assets/prompts/rust-mcp-server-generator.prompt.md +578 -0
- package/assets/prompts/shuffle-json-data.prompt.md +151 -0
- package/assets/prompts/sql-code-review.prompt.md +303 -0
- package/assets/prompts/sql-optimization.prompt.md +298 -0
- package/assets/prompts/suggest-awesome-github-copilot-agents.prompt.md +72 -0
- package/assets/prompts/suggest-awesome-github-copilot-chatmodes.prompt.md +71 -0
- package/assets/prompts/suggest-awesome-github-copilot-collections.prompt.md +149 -0
- package/assets/prompts/suggest-awesome-github-copilot-instructions.prompt.md +88 -0
- package/assets/prompts/suggest-awesome-github-copilot-prompts.prompt.md +71 -0
- package/assets/prompts/swift-mcp-server-generator.prompt.md +669 -0
- package/assets/prompts/technology-stack-blueprint-generator.prompt.md +242 -0
- package/assets/prompts/typescript-mcp-server-generator.prompt.md +90 -0
- package/assets/prompts/update-avm-modules-in-bicep.prompt.md +60 -0
- package/assets/prompts/update-implementation-plan.prompt.md +157 -0
- package/assets/prompts/update-llms.prompt.md +216 -0
- package/assets/prompts/update-markdown-file-index.prompt.md +76 -0
- package/assets/prompts/update-oo-component-documentation.prompt.md +162 -0
- package/assets/prompts/update-specification.prompt.md +127 -0
- package/assets/prompts/write-coding-standards-from-file.prompt.md +316 -0
- package/bin/cli.js +200 -0
- package/package.json +53 -0
- package/scripts/sync.js +99 -0
- package/verdaccio/config.yaml +202 -0
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
---
|
|
2
|
+
mode: 'agent'
|
|
3
|
+
description: 'Create GitHub Issues for unimplemented requirements from specification files using feature_request.yml template.'
|
|
4
|
+
tools: ['search/codebase', 'search', 'github', 'create_issue', 'search_issues', 'update_issue']
|
|
5
|
+
---
|
|
6
|
+
# Create GitHub Issues for Unmet Specification Requirements
|
|
7
|
+
|
|
8
|
+
Create GitHub Issues for unimplemented requirements in the specification at `${file}`.
|
|
9
|
+
|
|
10
|
+
## Process
|
|
11
|
+
|
|
12
|
+
1. Analyze specification file to extract all requirements
|
|
13
|
+
2. Check codebase implementation status for each requirement
|
|
14
|
+
3. Search existing issues using `search_issues` to avoid duplicates
|
|
15
|
+
4. Create new issue per unimplemented requirement using `create_issue`
|
|
16
|
+
5. Use `feature_request.yml` template (fallback to default)
|
|
17
|
+
|
|
18
|
+
## Requirements
|
|
19
|
+
|
|
20
|
+
- One issue per unimplemented requirement from specification
|
|
21
|
+
- Clear requirement ID and description mapping
|
|
22
|
+
- Include implementation guidance and acceptance criteria
|
|
23
|
+
- Verify against existing issues before creation
|
|
24
|
+
|
|
25
|
+
## Issue Content
|
|
26
|
+
|
|
27
|
+
- Title: Requirement ID and brief description
|
|
28
|
+
- Description: Detailed requirement, implementation method, and context
|
|
29
|
+
- Labels: feature, enhancement (as appropriate)
|
|
30
|
+
|
|
31
|
+
## Implementation Check
|
|
32
|
+
|
|
33
|
+
- Search codebase for related code patterns
|
|
34
|
+
- Check related specification files in `/spec/` directory
|
|
35
|
+
- Verify requirement isn't partially implemented
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
---
|
|
2
|
+
mode: 'agent'
|
|
3
|
+
description: 'Create GitHub Pull Request for feature request from specification file using pull_request_template.md template.'
|
|
4
|
+
tools: ['search/codebase', 'search', 'github', 'create_pull_request', 'update_pull_request', 'get_pull_request_diff']
|
|
5
|
+
---
|
|
6
|
+
# Create GitHub Pull Request from Specification
|
|
7
|
+
|
|
8
|
+
Create GitHub Pull Request for the specification at `${workspaceFolder}/.github/pull_request_template.md` .
|
|
9
|
+
|
|
10
|
+
## Process
|
|
11
|
+
|
|
12
|
+
1. Analyze specification file template from '${workspaceFolder}/.github/pull_request_template.md' to extract requirements by 'search' tool.
|
|
13
|
+
2. Create pull request draft template by using 'create_pull_request' tool on to `${input:targetBranch}`. and make sure don't have any pull request of current branch was exist `get_pull_request`. If has continue to step 4, and skip step 3.
|
|
14
|
+
3. Get changes in pull request by using 'get_pull_request_diff' tool to analyze information that was changed in pull Request.
|
|
15
|
+
4. Update the pull request body and title created in the previous step using the 'update_pull_request' tool. Incorporate the information from the template obtained in the first step to update the body and title as needed.
|
|
16
|
+
5. Switch from draft to ready for review by using 'update_pull_request' tool. To update state of pull request.
|
|
17
|
+
6. Using 'get_me' to get username of person was created pull request and assign to `update_issue` tool. To assign pull request
|
|
18
|
+
7. Response URL Pull request was create to user.
|
|
19
|
+
|
|
20
|
+
## Requirements
|
|
21
|
+
- Single pull request for the complete specification
|
|
22
|
+
- Clear title/pull_request_template.md identifying the specification
|
|
23
|
+
- Fill enough information into pull_request_template.md
|
|
24
|
+
- Verify against existing pull requests before creation
|
|
@@ -0,0 +1,157 @@
|
|
|
1
|
+
---
|
|
2
|
+
mode: 'agent'
|
|
3
|
+
description: 'Create a new implementation plan file for new features, refactoring existing code or upgrading packages, design, architecture or infrastructure.'
|
|
4
|
+
tools: ['changes', 'search/codebase', 'edit/editFiles', 'extensions', 'fetch', 'githubRepo', 'openSimpleBrowser', 'problems', 'runTasks', 'search', 'search/searchResults', 'runCommands/terminalLastCommand', 'runCommands/terminalSelection', 'testFailure', 'usages', 'vscodeAPI']
|
|
5
|
+
---
|
|
6
|
+
# Create Implementation Plan
|
|
7
|
+
|
|
8
|
+
## Primary Directive
|
|
9
|
+
|
|
10
|
+
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.
|
|
11
|
+
|
|
12
|
+
## Execution Context
|
|
13
|
+
|
|
14
|
+
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.
|
|
15
|
+
|
|
16
|
+
## Core Requirements
|
|
17
|
+
|
|
18
|
+
- Generate implementation plans that are fully executable by AI agents or humans
|
|
19
|
+
- Use deterministic language with zero ambiguity
|
|
20
|
+
- Structure all content for automated parsing and execution
|
|
21
|
+
- Ensure complete self-containment with no external dependencies for understanding
|
|
22
|
+
|
|
23
|
+
## Plan Structure Requirements
|
|
24
|
+
|
|
25
|
+
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.
|
|
26
|
+
|
|
27
|
+
## Phase Architecture
|
|
28
|
+
|
|
29
|
+
- Each phase must have measurable completion criteria
|
|
30
|
+
- Tasks within phases must be executable in parallel unless dependencies are specified
|
|
31
|
+
- All task descriptions must include specific file paths, function names, and exact implementation details
|
|
32
|
+
- No task should require human interpretation or decision-making
|
|
33
|
+
|
|
34
|
+
## AI-Optimized Implementation Standards
|
|
35
|
+
|
|
36
|
+
- Use explicit, unambiguous language with zero interpretation required
|
|
37
|
+
- Structure all content as machine-parseable formats (tables, lists, structured data)
|
|
38
|
+
- Include specific file paths, line numbers, and exact code references where applicable
|
|
39
|
+
- Define all variables, constants, and configuration values explicitly
|
|
40
|
+
- Provide complete context within each task description
|
|
41
|
+
- Use standardized prefixes for all identifiers (REQ-, TASK-, etc.)
|
|
42
|
+
- Include validation criteria that can be automatically verified
|
|
43
|
+
|
|
44
|
+
## Output File Specifications
|
|
45
|
+
|
|
46
|
+
- Save implementation plan files in `/plan/` directory
|
|
47
|
+
- Use naming convention: `[purpose]-[component]-[version].md`
|
|
48
|
+
- Purpose prefixes: `upgrade|refactor|feature|data|infrastructure|process|architecture|design`
|
|
49
|
+
- Example: `upgrade-system-command-4.md`, `feature-auth-module-1.md`
|
|
50
|
+
- File must be valid Markdown with proper front matter structure
|
|
51
|
+
|
|
52
|
+
## Mandatory Template Structure
|
|
53
|
+
|
|
54
|
+
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.
|
|
55
|
+
|
|
56
|
+
## Template Validation Rules
|
|
57
|
+
|
|
58
|
+
- All front matter fields must be present and properly formatted
|
|
59
|
+
- All section headers must match exactly (case-sensitive)
|
|
60
|
+
- All identifier prefixes must follow the specified format
|
|
61
|
+
- Tables must include all required columns
|
|
62
|
+
- No placeholder text may remain in the final output
|
|
63
|
+
|
|
64
|
+
## Status
|
|
65
|
+
|
|
66
|
+
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.
|
|
67
|
+
|
|
68
|
+
```md
|
|
69
|
+
---
|
|
70
|
+
goal: [Concise Title Describing the Package Implementation Plan's Goal]
|
|
71
|
+
version: [Optional: e.g., 1.0, Date]
|
|
72
|
+
date_created: [YYYY-MM-DD]
|
|
73
|
+
last_updated: [Optional: YYYY-MM-DD]
|
|
74
|
+
owner: [Optional: Team/Individual responsible for this spec]
|
|
75
|
+
status: 'Completed'|'In progress'|'Planned'|'Deprecated'|'On Hold'
|
|
76
|
+
tags: [Optional: List of relevant tags or categories, e.g., `feature`, `upgrade`, `chore`, `architecture`, `migration`, `bug` etc]
|
|
77
|
+
---
|
|
78
|
+
|
|
79
|
+
# Introduction
|
|
80
|
+
|
|
81
|
+

|
|
82
|
+
|
|
83
|
+
[A short concise introduction to the plan and the goal it is intended to achieve.]
|
|
84
|
+
|
|
85
|
+
## 1. Requirements & Constraints
|
|
86
|
+
|
|
87
|
+
[Explicitly list all requirements & constraints that affect the plan and constrain how it is implemented. Use bullet points or tables for clarity.]
|
|
88
|
+
|
|
89
|
+
- **REQ-001**: Requirement 1
|
|
90
|
+
- **SEC-001**: Security Requirement 1
|
|
91
|
+
- **[3 LETTERS]-001**: Other Requirement 1
|
|
92
|
+
- **CON-001**: Constraint 1
|
|
93
|
+
- **GUD-001**: Guideline 1
|
|
94
|
+
- **PAT-001**: Pattern to follow 1
|
|
95
|
+
|
|
96
|
+
## 2. Implementation Steps
|
|
97
|
+
|
|
98
|
+
### Implementation Phase 1
|
|
99
|
+
|
|
100
|
+
- GOAL-001: [Describe the goal of this phase, e.g., "Implement feature X", "Refactor module Y", etc.]
|
|
101
|
+
|
|
102
|
+
| Task | Description | Completed | Date |
|
|
103
|
+
|------|-------------|-----------|------|
|
|
104
|
+
| TASK-001 | Description of task 1 | ✅ | 2025-04-25 |
|
|
105
|
+
| TASK-002 | Description of task 2 | | |
|
|
106
|
+
| TASK-003 | Description of task 3 | | |
|
|
107
|
+
|
|
108
|
+
### Implementation Phase 2
|
|
109
|
+
|
|
110
|
+
- GOAL-002: [Describe the goal of this phase, e.g., "Implement feature X", "Refactor module Y", etc.]
|
|
111
|
+
|
|
112
|
+
| Task | Description | Completed | Date |
|
|
113
|
+
|------|-------------|-----------|------|
|
|
114
|
+
| TASK-004 | Description of task 4 | | |
|
|
115
|
+
| TASK-005 | Description of task 5 | | |
|
|
116
|
+
| TASK-006 | Description of task 6 | | |
|
|
117
|
+
|
|
118
|
+
## 3. Alternatives
|
|
119
|
+
|
|
120
|
+
[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.]
|
|
121
|
+
|
|
122
|
+
- **ALT-001**: Alternative approach 1
|
|
123
|
+
- **ALT-002**: Alternative approach 2
|
|
124
|
+
|
|
125
|
+
## 4. Dependencies
|
|
126
|
+
|
|
127
|
+
[List any dependencies that need to be addressed, such as libraries, frameworks, or other components that the plan relies on.]
|
|
128
|
+
|
|
129
|
+
- **DEP-001**: Dependency 1
|
|
130
|
+
- **DEP-002**: Dependency 2
|
|
131
|
+
|
|
132
|
+
## 5. Files
|
|
133
|
+
|
|
134
|
+
[List the files that will be affected by the feature or refactoring task.]
|
|
135
|
+
|
|
136
|
+
- **FILE-001**: Description of file 1
|
|
137
|
+
- **FILE-002**: Description of file 2
|
|
138
|
+
|
|
139
|
+
## 6. Testing
|
|
140
|
+
|
|
141
|
+
[List the tests that need to be implemented to verify the feature or refactoring task.]
|
|
142
|
+
|
|
143
|
+
- **TEST-001**: Description of test 1
|
|
144
|
+
- **TEST-002**: Description of test 2
|
|
145
|
+
|
|
146
|
+
## 7. Risks & Assumptions
|
|
147
|
+
|
|
148
|
+
[List any risks or assumptions related to the implementation of the plan.]
|
|
149
|
+
|
|
150
|
+
- **RISK-001**: Risk 1
|
|
151
|
+
- **ASSUMPTION-001**: Assumption 1
|
|
152
|
+
|
|
153
|
+
## 8. Related Specifications / Further Reading
|
|
154
|
+
|
|
155
|
+
[Link to related spec 1]
|
|
156
|
+
[Link to relevant external documentation]
|
|
157
|
+
```
|
|
@@ -0,0 +1,210 @@
|
|
|
1
|
+
---
|
|
2
|
+
mode: 'agent'
|
|
3
|
+
description: 'Create an llms.txt file from scratch based on repository structure following the llms.txt specification at https://llmstxt.org/'
|
|
4
|
+
tools: ['changes', 'search/codebase', 'edit/editFiles', 'extensions', 'fetch', 'githubRepo', 'openSimpleBrowser', 'problems', 'runTasks', 'search', 'search/searchResults', 'runCommands/terminalLastCommand', 'runCommands/terminalSelection', 'testFailure', 'usages', 'vscodeAPI']
|
|
5
|
+
---
|
|
6
|
+
# Create LLMs.txt File from Repository Structure
|
|
7
|
+
|
|
8
|
+
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.
|
|
9
|
+
|
|
10
|
+
## Primary Directive
|
|
11
|
+
|
|
12
|
+
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.
|
|
13
|
+
|
|
14
|
+
## Analysis and Planning Phase
|
|
15
|
+
|
|
16
|
+
Before creating the `llms.txt` file, you must complete a thorough analysis:
|
|
17
|
+
|
|
18
|
+
### Step 1: Review llms.txt Specification
|
|
19
|
+
|
|
20
|
+
- Review the official specification at https://llmstxt.org/ to ensure full compliance
|
|
21
|
+
- Understand the required format structure and guidelines
|
|
22
|
+
- Note the specific markdown structure requirements
|
|
23
|
+
|
|
24
|
+
### Step 2: Repository Structure Analysis
|
|
25
|
+
|
|
26
|
+
- Examine the complete repository structure using appropriate tools
|
|
27
|
+
- Identify the primary purpose and scope of the repository
|
|
28
|
+
- Catalog all important directories and their purposes
|
|
29
|
+
- List key files that would be valuable for LLM understanding
|
|
30
|
+
|
|
31
|
+
### Step 3: Content Discovery
|
|
32
|
+
|
|
33
|
+
- Identify README files and their locations
|
|
34
|
+
- Find documentation files (`.md` files in `/docs/`, `/spec/`, etc.)
|
|
35
|
+
- Locate specification files and their purposes
|
|
36
|
+
- Discover configuration files and their relevance
|
|
37
|
+
- Find example files and code samples
|
|
38
|
+
- Identify any existing documentation structure
|
|
39
|
+
|
|
40
|
+
### Step 4: Create Implementation Plan
|
|
41
|
+
|
|
42
|
+
Based on your analysis, create a structured plan that includes:
|
|
43
|
+
|
|
44
|
+
- Repository purpose and scope summary
|
|
45
|
+
- Priority-ordered list of essential files for LLM understanding
|
|
46
|
+
- Secondary files that provide additional context
|
|
47
|
+
- Organizational structure for the llms.txt file
|
|
48
|
+
|
|
49
|
+
## Implementation Requirements
|
|
50
|
+
|
|
51
|
+
### Format Compliance
|
|
52
|
+
|
|
53
|
+
The `llms.txt` file must follow this exact structure per the specification:
|
|
54
|
+
|
|
55
|
+
1. **H1 Header**: Single line with repository/project name (required)
|
|
56
|
+
2. **Blockquote Summary**: Brief description in blockquote format (optional but recommended)
|
|
57
|
+
3. **Additional Details**: Zero or more markdown sections without headings for context
|
|
58
|
+
4. **File List Sections**: Zero or more H2 sections containing markdown lists of links
|
|
59
|
+
|
|
60
|
+
### Content Requirements
|
|
61
|
+
|
|
62
|
+
#### Required Elements
|
|
63
|
+
|
|
64
|
+
- **Project Name**: Clear, descriptive title as H1
|
|
65
|
+
- **Summary**: Concise blockquote explaining the repository's purpose
|
|
66
|
+
- **Key Files**: Essential files organized by category (H2 sections)
|
|
67
|
+
|
|
68
|
+
#### File Link Format
|
|
69
|
+
|
|
70
|
+
Each file link must follow: `[descriptive-name](relative-url): optional description`
|
|
71
|
+
|
|
72
|
+
#### Section Organization
|
|
73
|
+
|
|
74
|
+
Organize files into logical H2 sections such as:
|
|
75
|
+
|
|
76
|
+
- **Documentation**: Core documentation files
|
|
77
|
+
- **Specifications**: Technical specifications and requirements
|
|
78
|
+
- **Examples**: Sample code and usage examples
|
|
79
|
+
- **Configuration**: Setup and configuration files
|
|
80
|
+
- **Optional**: Secondary files (special meaning - can be skipped for shorter context)
|
|
81
|
+
|
|
82
|
+
### Content Guidelines
|
|
83
|
+
|
|
84
|
+
#### Language and Style
|
|
85
|
+
|
|
86
|
+
- Use concise, clear, unambiguous language
|
|
87
|
+
- Avoid jargon without explanation
|
|
88
|
+
- Write for both human and LLM readers
|
|
89
|
+
- Be specific and informative in descriptions
|
|
90
|
+
|
|
91
|
+
#### File Selection Criteria
|
|
92
|
+
|
|
93
|
+
Include files that:
|
|
94
|
+
- Explain the repository's purpose and scope
|
|
95
|
+
- Provide essential technical documentation
|
|
96
|
+
- Show usage examples and patterns
|
|
97
|
+
- Define interfaces and specifications
|
|
98
|
+
- Contain configuration and setup instructions
|
|
99
|
+
|
|
100
|
+
Exclude files that:
|
|
101
|
+
- Are purely implementation details
|
|
102
|
+
- Contain redundant information
|
|
103
|
+
- Are build artifacts or generated content
|
|
104
|
+
- Are not relevant to understanding the project
|
|
105
|
+
|
|
106
|
+
## Execution Steps
|
|
107
|
+
|
|
108
|
+
### Step 1: Repository Analysis
|
|
109
|
+
|
|
110
|
+
1. Examine the repository structure completely
|
|
111
|
+
2. Read the main README.md to understand the project
|
|
112
|
+
3. Identify all documentation directories and files
|
|
113
|
+
4. Catalog specification files and their purposes
|
|
114
|
+
5. Find example files and configuration files
|
|
115
|
+
|
|
116
|
+
### Step 2: Content Planning
|
|
117
|
+
|
|
118
|
+
1. Determine the primary purpose statement
|
|
119
|
+
2. Write a concise summary for the blockquote
|
|
120
|
+
3. Group identified files into logical categories
|
|
121
|
+
4. Prioritize files by importance for LLM understanding
|
|
122
|
+
5. Create descriptions for each file link
|
|
123
|
+
|
|
124
|
+
### Step 3: File Creation
|
|
125
|
+
|
|
126
|
+
1. Create the `llms.txt` file in the repository root
|
|
127
|
+
2. Follow the exact format specification
|
|
128
|
+
3. Include all required sections
|
|
129
|
+
4. Use proper markdown formatting
|
|
130
|
+
5. Ensure all links are valid relative paths
|
|
131
|
+
|
|
132
|
+
### Step 4: Validation
|
|
133
|
+
1. Verify compliance with https://llmstxt.org/ specification
|
|
134
|
+
2. Check that all links are valid and accessible
|
|
135
|
+
3. Ensure the file serves as an effective LLM navigation tool
|
|
136
|
+
4. Confirm the file is both human and machine readable
|
|
137
|
+
|
|
138
|
+
## Quality Assurance
|
|
139
|
+
|
|
140
|
+
### Format Validation
|
|
141
|
+
|
|
142
|
+
- ✅ H1 header with project name
|
|
143
|
+
- ✅ Blockquote summary (if included)
|
|
144
|
+
- ✅ H2 sections for file lists
|
|
145
|
+
- ✅ Proper markdown link format
|
|
146
|
+
- ✅ No broken or invalid links
|
|
147
|
+
- ✅ Consistent formatting throughout
|
|
148
|
+
|
|
149
|
+
### Content Validation
|
|
150
|
+
|
|
151
|
+
- ✅ Clear, unambiguous language
|
|
152
|
+
- ✅ Comprehensive coverage of essential files
|
|
153
|
+
- ✅ Logical organization of content
|
|
154
|
+
- ✅ Appropriate file descriptions
|
|
155
|
+
- ✅ Serves as effective LLM navigation tool
|
|
156
|
+
|
|
157
|
+
### Specification Compliance
|
|
158
|
+
|
|
159
|
+
- ✅ Follows https://llmstxt.org/ format exactly
|
|
160
|
+
- ✅ Uses required markdown structure
|
|
161
|
+
- ✅ Implements optional sections appropriately
|
|
162
|
+
- ✅ File located at repository root (`/llms.txt`)
|
|
163
|
+
|
|
164
|
+
## Example Structure Template
|
|
165
|
+
|
|
166
|
+
```txt
|
|
167
|
+
# [Repository Name]
|
|
168
|
+
|
|
169
|
+
> [Concise description of the repository's purpose and scope]
|
|
170
|
+
|
|
171
|
+
[Optional additional context paragraphs without headings]
|
|
172
|
+
|
|
173
|
+
## Documentation
|
|
174
|
+
|
|
175
|
+
- [Main README](README.md): Primary project documentation and getting started guide
|
|
176
|
+
- [Contributing Guide](CONTRIBUTING.md): Guidelines for contributing to the project
|
|
177
|
+
- [Code of Conduct](CODE_OF_CONDUCT.md): Community guidelines and expectations
|
|
178
|
+
|
|
179
|
+
## Specifications
|
|
180
|
+
|
|
181
|
+
- [Technical Specification](spec/technical-spec.md): Detailed technical requirements and constraints
|
|
182
|
+
- [API Specification](spec/api-spec.md): Interface definitions and data contracts
|
|
183
|
+
|
|
184
|
+
## Examples
|
|
185
|
+
|
|
186
|
+
- [Basic Example](examples/basic-usage.md): Simple usage demonstration
|
|
187
|
+
- [Advanced Example](examples/advanced-usage.md): Complex implementation patterns
|
|
188
|
+
|
|
189
|
+
## Configuration
|
|
190
|
+
|
|
191
|
+
- [Setup Guide](docs/setup.md): Installation and configuration instructions
|
|
192
|
+
- [Deployment Guide](docs/deployment.md): Production deployment guidelines
|
|
193
|
+
|
|
194
|
+
## Optional
|
|
195
|
+
|
|
196
|
+
- [Architecture Documentation](docs/architecture.md): Detailed system architecture
|
|
197
|
+
- [Design Decisions](docs/decisions.md): Historical design decision records
|
|
198
|
+
```
|
|
199
|
+
|
|
200
|
+
## Success Criteria
|
|
201
|
+
|
|
202
|
+
The created `llms.txt` file should:
|
|
203
|
+
1. Enable LLMs to quickly understand the repository's purpose
|
|
204
|
+
2. Provide clear navigation to essential documentation
|
|
205
|
+
3. Follow the official llms.txt specification exactly
|
|
206
|
+
4. Be comprehensive yet concise
|
|
207
|
+
5. Serve both human and machine readers effectively
|
|
208
|
+
6. Include all critical files for project understanding
|
|
209
|
+
7. Use clear, unambiguous language throughout
|
|
210
|
+
8. Organize content logically for easy consumption
|
|
@@ -0,0 +1,193 @@
|
|
|
1
|
+
---
|
|
2
|
+
mode: 'agent'
|
|
3
|
+
description: 'Create comprehensive, standardized documentation for object-oriented components following industry best practices and architectural documentation standards.'
|
|
4
|
+
tools: ['changes', 'search/codebase', 'edit/editFiles', 'extensions', 'fetch', 'githubRepo', 'openSimpleBrowser', 'problems', 'runTasks', 'search', 'search/searchResults', 'runCommands/terminalLastCommand', 'runCommands/terminalSelection', 'testFailure', 'usages', 'vscodeAPI']
|
|
5
|
+
---
|
|
6
|
+
# Generate Standard OO Component Documentation
|
|
7
|
+
|
|
8
|
+
Create comprehensive documentation for the object-oriented component(s) at: `${input:ComponentPath}`.
|
|
9
|
+
|
|
10
|
+
Analyze the component by examining code in the provided path. If folder, analyze all source files. If single file, treat as main component and analyze related files in same directory.
|
|
11
|
+
|
|
12
|
+
## Documentation Standards
|
|
13
|
+
|
|
14
|
+
- DOC-001: Follow C4 Model documentation levels (Context, Containers, Components, Code)
|
|
15
|
+
- DOC-002: Align with Arc42 software architecture documentation template
|
|
16
|
+
- DOC-003: Comply with IEEE 1016 Software Design Description standard
|
|
17
|
+
- DOC-004: Use Agile Documentation principles (just enough documentation that adds value)
|
|
18
|
+
- DOC-005: Target developers and maintainers as primary audience
|
|
19
|
+
|
|
20
|
+
## Analysis Instructions
|
|
21
|
+
|
|
22
|
+
- ANA-001: Determine path type (folder vs single file) and identify primary component
|
|
23
|
+
- ANA-002: Examine source code files for class structures and inheritance
|
|
24
|
+
- ANA-003: Identify design patterns and architectural decisions
|
|
25
|
+
- ANA-004: Document public APIs, interfaces, and dependencies
|
|
26
|
+
- ANA-005: Recognize creational/structural/behavioral patterns
|
|
27
|
+
- ANA-006: Document method parameters, return values, exceptions
|
|
28
|
+
- ANA-007: Assess performance, security, reliability, maintainability
|
|
29
|
+
- ANA-008: Infer integration patterns and data flow
|
|
30
|
+
|
|
31
|
+
## Language-Specific Optimizations
|
|
32
|
+
|
|
33
|
+
- LNG-001: **C#/.NET** - async/await, dependency injection, configuration, disposal
|
|
34
|
+
- LNG-002: **Java** - Spring framework, annotations, exception handling, packaging
|
|
35
|
+
- LNG-003: **TypeScript/JavaScript** - modules, async patterns, types, npm
|
|
36
|
+
- LNG-004: **Python** - packages, virtual environments, type hints, testing
|
|
37
|
+
|
|
38
|
+
## Error Handling
|
|
39
|
+
|
|
40
|
+
- ERR-001: Path doesn't exist - provide correct format guidance
|
|
41
|
+
- ERR-002: No source files found - suggest alternative locations
|
|
42
|
+
- ERR-003: Unclear structure - document findings and request clarification
|
|
43
|
+
- ERR-004: Non-standard patterns - document custom approaches
|
|
44
|
+
- ERR-005: Insufficient code - focus on available information, highlight gaps
|
|
45
|
+
|
|
46
|
+
## Output Format
|
|
47
|
+
|
|
48
|
+
Generate well-structured Markdown with clear heading hierarchy, code blocks, tables, bullet points, and proper formatting for readability and maintainability.
|
|
49
|
+
|
|
50
|
+
## File Location
|
|
51
|
+
|
|
52
|
+
The documentation should be saved in the `/docs/components/` directory and named according to the convention: `[component-name]-documentation.md`.
|
|
53
|
+
|
|
54
|
+
## Required Documentation Structure
|
|
55
|
+
|
|
56
|
+
The documentation file 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:
|
|
57
|
+
|
|
58
|
+
```md
|
|
59
|
+
---
|
|
60
|
+
title: [Component Name] - Technical Documentation
|
|
61
|
+
component_path: `${input:ComponentPath}`
|
|
62
|
+
version: [Optional: e.g., 1.0, Date]
|
|
63
|
+
date_created: [YYYY-MM-DD]
|
|
64
|
+
last_updated: [Optional: YYYY-MM-DD]
|
|
65
|
+
owner: [Optional: Team/Individual responsible for this component]
|
|
66
|
+
tags: [Optional: List of relevant tags or categories, e.g., `component`,`service`,`tool`,`infrastructure`,`documentation`,`architecture` etc]
|
|
67
|
+
---
|
|
68
|
+
|
|
69
|
+
# [Component Name] Documentation
|
|
70
|
+
|
|
71
|
+
[A short concise introduction to the component and its purpose within the system.]
|
|
72
|
+
|
|
73
|
+
## 1. Component Overview
|
|
74
|
+
|
|
75
|
+
### Purpose/Responsibility
|
|
76
|
+
- OVR-001: State component's primary responsibility
|
|
77
|
+
- OVR-002: Define scope (included/excluded functionality)
|
|
78
|
+
- OVR-003: Describe system context and relationships
|
|
79
|
+
|
|
80
|
+
## 2. Architecture Section
|
|
81
|
+
|
|
82
|
+
- ARC-001: Document design patterns used (Repository, Factory, Observer, etc.)
|
|
83
|
+
- ARC-002: List internal and external dependencies with purposes
|
|
84
|
+
- ARC-003: Document component interactions and relationships
|
|
85
|
+
- ARC-004: Include visual diagrams (UML class, sequence, component)
|
|
86
|
+
- ARC-005: Create mermaid diagram showing component structure, relationships, and dependencies
|
|
87
|
+
|
|
88
|
+
### Component Structure and Dependencies Diagram
|
|
89
|
+
|
|
90
|
+
Include a comprehensive mermaid diagram that shows:
|
|
91
|
+
- **Component structure** - Main classes, interfaces, and their relationships
|
|
92
|
+
- **Internal dependencies** - How components interact within the system
|
|
93
|
+
- **External dependencies** - External libraries, services, databases, APIs
|
|
94
|
+
- **Data flow** - Direction of dependencies and interactions
|
|
95
|
+
- **Inheritance/composition** - Class hierarchies and composition relationships
|
|
96
|
+
|
|
97
|
+
```mermaid
|
|
98
|
+
graph TD
|
|
99
|
+
subgraph "Component System"
|
|
100
|
+
A[Main Component] --> B[Internal Service]
|
|
101
|
+
A --> C[Internal Repository]
|
|
102
|
+
B --> D[Business Logic]
|
|
103
|
+
C --> E[Data Access Layer]
|
|
104
|
+
end
|
|
105
|
+
|
|
106
|
+
subgraph "External Dependencies"
|
|
107
|
+
F[External API]
|
|
108
|
+
G[Database]
|
|
109
|
+
H[Third-party Library]
|
|
110
|
+
I[Configuration Service]
|
|
111
|
+
end
|
|
112
|
+
|
|
113
|
+
A --> F
|
|
114
|
+
E --> G
|
|
115
|
+
B --> H
|
|
116
|
+
A --> I
|
|
117
|
+
|
|
118
|
+
classDiagram
|
|
119
|
+
class MainComponent {
|
|
120
|
+
+property: Type
|
|
121
|
+
+method(): ReturnType
|
|
122
|
+
+asyncMethod(): Promise~Type~
|
|
123
|
+
}
|
|
124
|
+
class InternalService {
|
|
125
|
+
+businessOperation(): Result
|
|
126
|
+
}
|
|
127
|
+
class ExternalAPI {
|
|
128
|
+
<<external>>
|
|
129
|
+
+apiCall(): Data
|
|
130
|
+
}
|
|
131
|
+
|
|
132
|
+
MainComponent --> InternalService
|
|
133
|
+
MainComponent --> ExternalAPI
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
## 3. Interface Documentation
|
|
137
|
+
|
|
138
|
+
- INT-001: Document all public interfaces and usage patterns
|
|
139
|
+
- INT-002: Create method/property reference table
|
|
140
|
+
- INT-003: Document events/callbacks/notification mechanisms
|
|
141
|
+
|
|
142
|
+
| Method/Property | Purpose | Parameters | Return Type | Usage Notes |
|
|
143
|
+
|-----------------|---------|------------|-------------|-------------|
|
|
144
|
+
| [Name] | [Purpose] | [Parameters] | [Type] | [Notes] |
|
|
145
|
+
|
|
146
|
+
## 4. Implementation Details
|
|
147
|
+
|
|
148
|
+
- IMP-001: Document main implementation classes and responsibilities
|
|
149
|
+
- IMP-002: Describe configuration requirements and initialization
|
|
150
|
+
- IMP-003: Document key algorithms and business logic
|
|
151
|
+
- IMP-004: Note performance characteristics and bottlenecks
|
|
152
|
+
|
|
153
|
+
## 5. Usage Examples
|
|
154
|
+
|
|
155
|
+
### Basic Usage
|
|
156
|
+
|
|
157
|
+
```csharp
|
|
158
|
+
// Basic usage example
|
|
159
|
+
var component = new ComponentName();
|
|
160
|
+
component.DoSomething();
|
|
161
|
+
```
|
|
162
|
+
|
|
163
|
+
### Advanced Usage
|
|
164
|
+
|
|
165
|
+
```csharp
|
|
166
|
+
// Advanced configuration patterns
|
|
167
|
+
var options = new ComponentOptions();
|
|
168
|
+
var component = ComponentFactory.Create(options);
|
|
169
|
+
await component.ProcessAsync(data);
|
|
170
|
+
```
|
|
171
|
+
|
|
172
|
+
- USE-001: Provide basic usage examples
|
|
173
|
+
- USE-002: Show advanced configuration patterns
|
|
174
|
+
- USE-003: Document best practices and recommended patterns
|
|
175
|
+
|
|
176
|
+
## 6. Quality Attributes
|
|
177
|
+
|
|
178
|
+
- QUA-001: Security (authentication, authorization, data protection)
|
|
179
|
+
- QUA-002: Performance (characteristics, scalability, resource usage)
|
|
180
|
+
- QUA-003: Reliability (error handling, fault tolerance, recovery)
|
|
181
|
+
- QUA-004: Maintainability (standards, testing, documentation)
|
|
182
|
+
- QUA-005: Extensibility (extension points, customization options)
|
|
183
|
+
|
|
184
|
+
## 7. Reference Information
|
|
185
|
+
|
|
186
|
+
- REF-001: List dependencies with versions and purposes
|
|
187
|
+
- REF-002: Complete configuration options reference
|
|
188
|
+
- REF-003: Testing guidelines and mock setup
|
|
189
|
+
- REF-004: Troubleshooting (common issues, error messages)
|
|
190
|
+
- REF-005: Related documentation links
|
|
191
|
+
- REF-006: Change history and migration notes
|
|
192
|
+
|
|
193
|
+
```
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
---
|
|
2
|
+
mode: 'agent'
|
|
3
|
+
description: 'Create a README.md file for the project'
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
## Role
|
|
7
|
+
|
|
8
|
+
You're a senior expert software engineer with extensive experience in open source projects. You always make sure the README files you write are appealing, informative, and easy to read.
|
|
9
|
+
|
|
10
|
+
## Task
|
|
11
|
+
|
|
12
|
+
1. Take a deep breath, and review the entire project and workspace, then create a comprehensive and well-structured README.md file for the project.
|
|
13
|
+
2. Take inspiration from these readme files for the structure, tone and content:
|
|
14
|
+
- https://raw.githubusercontent.com/Azure-Samples/serverless-chat-langchainjs/refs/heads/main/README.md
|
|
15
|
+
- https://raw.githubusercontent.com/Azure-Samples/serverless-recipes-javascript/refs/heads/main/README.md
|
|
16
|
+
- https://raw.githubusercontent.com/sinedied/run-on-output/refs/heads/main/README.md
|
|
17
|
+
- https://raw.githubusercontent.com/sinedied/smoke/refs/heads/main/README.md
|
|
18
|
+
3. Do not overuse emojis, and keep the readme concise and to the point.
|
|
19
|
+
4. Do not include sections like "LICENSE", "CONTRIBUTING", "CHANGELOG", etc. There are dedicated files for those sections.
|
|
20
|
+
5. Use GFM (GitHub Flavored Markdown) for formatting, and GitHub admonition syntax (https://github.com/orgs/community/discussions/16925) where appropriate.
|
|
21
|
+
6. If you find a logo or icon for the project, use it in the readme's header.
|