@jakkrichm/create-nexus-devflow 2.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +82 -0
- package/bin/create-nexus-devflow.js +275 -0
- package/lib/update.js +379 -0
- package/package.json +53 -0
- package/template/.agents/skills/00-discover/SKILL.md +170 -0
- package/template/.agents/skills/10-define/SKILL.md +170 -0
- package/template/.agents/skills/20-spec/SKILL.md +156 -0
- package/template/.agents/skills/30-plan/SKILL.md +221 -0
- package/template/.agents/skills/40-implement/SKILL.md +166 -0
- package/template/.agents/skills/50-verify/SKILL.md +188 -0
- package/template/.agents/skills/60-report/SKILL.md +183 -0
- package/template/.agents/skills/70-release/SKILL.md +155 -0
- package/template/.agents/skills/9arm-skills/README.md +51 -0
- package/template/.agents/skills/9arm-skills/debug-mantra/SKILL.md +86 -0
- package/template/.agents/skills/9arm-skills/management-talk/SKILL.md +79 -0
- package/template/.agents/skills/9arm-skills/post-mortem/SKILL.md +71 -0
- package/template/.agents/skills/9arm-skills/scrutinize/SKILL.md +72 -0
- package/template/.agents/skills/agent/SKILL.md +165 -0
- package/template/.agents/skills/api-and-interface-design/SKILL.md +294 -0
- package/template/.agents/skills/app-builder/SKILL.md +75 -0
- package/template/.agents/skills/app-builder/agent-coordination.md +71 -0
- package/template/.agents/skills/app-builder/feature-building.md +53 -0
- package/template/.agents/skills/app-builder/project-detection.md +34 -0
- package/template/.agents/skills/app-builder/scaffolding.md +118 -0
- package/template/.agents/skills/app-builder/tech-stack.md +40 -0
- package/template/.agents/skills/app-builder/templates/SKILL.md +39 -0
- package/template/.agents/skills/app-builder/templates/astro-static/TEMPLATE.md +76 -0
- package/template/.agents/skills/app-builder/templates/chrome-extension/TEMPLATE.md +92 -0
- package/template/.agents/skills/app-builder/templates/cli-tool/TEMPLATE.md +88 -0
- package/template/.agents/skills/app-builder/templates/electron-desktop/TEMPLATE.md +88 -0
- package/template/.agents/skills/app-builder/templates/express-api/TEMPLATE.md +83 -0
- package/template/.agents/skills/app-builder/templates/flutter-app/TEMPLATE.md +90 -0
- package/template/.agents/skills/app-builder/templates/monorepo-turborepo/TEMPLATE.md +90 -0
- package/template/.agents/skills/app-builder/templates/nextjs-fullstack/TEMPLATE.md +122 -0
- package/template/.agents/skills/app-builder/templates/nextjs-saas/TEMPLATE.md +122 -0
- package/template/.agents/skills/app-builder/templates/nextjs-static/TEMPLATE.md +169 -0
- package/template/.agents/skills/app-builder/templates/nuxt-app/TEMPLATE.md +134 -0
- package/template/.agents/skills/app-builder/templates/python-fastapi/TEMPLATE.md +83 -0
- package/template/.agents/skills/app-builder/templates/react-native-app/TEMPLATE.md +119 -0
- package/template/.agents/skills/architecture/SKILL.md +55 -0
- package/template/.agents/skills/architecture/context-discovery.md +43 -0
- package/template/.agents/skills/architecture/examples.md +94 -0
- package/template/.agents/skills/architecture/pattern-selection.md +68 -0
- package/template/.agents/skills/architecture/patterns-reference.md +50 -0
- package/template/.agents/skills/architecture/trade-off-analysis.md +77 -0
- package/template/.agents/skills/bash-linux/SKILL.md +199 -0
- package/template/.agents/skills/behavioral-modes/SKILL.md +242 -0
- package/template/.agents/skills/brainstorm/SKILL.md +168 -0
- package/template/.agents/skills/browser-testing-with-devtools/SKILL.md +302 -0
- package/template/.agents/skills/changelog/SKILL.md +109 -0
- package/template/.agents/skills/check-for-updates/SKILL.md +117 -0
- package/template/.agents/skills/ci-cd-and-automation/SKILL.md +390 -0
- package/template/.agents/skills/code-review-and-quality/SKILL.md +392 -0
- package/template/.agents/skills/code-simplification/SKILL.md +331 -0
- package/template/.agents/skills/codebase-design/DEEPENING.md +24 -0
- package/template/.agents/skills/codebase-design/DESIGN-IT-TWICE.md +28 -0
- package/template/.agents/skills/codebase-design/SKILL.md +58 -0
- package/template/.agents/skills/commit/SKILL.md +63 -0
- package/template/.agents/skills/competitor-analysis/SKILL.md +66 -0
- package/template/.agents/skills/context-engineering/SKILL.md +290 -0
- package/template/.agents/skills/database-design/SKILL.md +52 -0
- package/template/.agents/skills/database-design/database-selection.md +43 -0
- package/template/.agents/skills/database-design/indexing.md +39 -0
- package/template/.agents/skills/database-design/migrations.md +48 -0
- package/template/.agents/skills/database-design/optimization.md +36 -0
- package/template/.agents/skills/database-design/orm-selection.md +30 -0
- package/template/.agents/skills/database-design/schema-design.md +56 -0
- package/template/.agents/skills/database-design/scripts/schema_validator.py +172 -0
- package/template/.agents/skills/debug/SKILL.md +131 -0
- package/template/.agents/skills/debugging-and-error-recovery/SKILL.md +298 -0
- package/template/.agents/skills/deploy/SKILL.md +91 -0
- package/template/.agents/skills/deployment-procedures/SKILL.md +241 -0
- package/template/.agents/skills/deprecation-and-migration/SKILL.md +206 -0
- package/template/.agents/skills/devflow/SKILL.md +89 -0
- package/template/.agents/skills/devflow-concept-intake/SKILL.md +150 -0
- package/template/.agents/skills/devflow-concept-intake/agents/openai.yaml +4 -0
- package/template/.agents/skills/devflow-concept-intake/references/adoption-proposal-template.md +60 -0
- package/template/.agents/skills/devflow-concept-intake/references/concept-report-template.md +47 -0
- package/template/.agents/skills/devflow-concept-intake/references/upstream-tracking-template.md +51 -0
- package/template/.agents/skills/devflow-wiki/SKILL.md +75 -0
- package/template/.agents/skills/diagnosing-bugs/SKILL.md +93 -0
- package/template/.agents/skills/documentation-and-adrs/SKILL.md +278 -0
- package/template/.agents/skills/domain-modeling/ADR-FORMAT.md +47 -0
- package/template/.agents/skills/domain-modeling/CONTEXT-FORMAT.md +60 -0
- package/template/.agents/skills/domain-modeling/SKILL.md +74 -0
- package/template/.agents/skills/english-to-thai-translator/SKILL.md +125 -0
- package/template/.agents/skills/followup/SKILL.md +83 -0
- package/template/.agents/skills/frontend-ui-engineering/SKILL.md +326 -0
- package/template/.agents/skills/frontend-ui-engineering/accessibility-checklist.md +159 -0
- package/template/.agents/skills/git-workflow-and-versioning/SKILL.md +300 -0
- package/template/.agents/skills/goal/SKILL.md +148 -0
- package/template/.agents/skills/handoff/SKILL.md +46 -0
- package/template/.agents/skills/help/SKILL.md +253 -0
- package/template/.agents/skills/human-review-decisions/SKILL.md +74 -0
- package/template/.agents/skills/i18n-localization/SKILL.md +154 -0
- package/template/.agents/skills/i18n-localization/scripts/i18n_checker.py +241 -0
- package/template/.agents/skills/idea-refine/SKILL.md +178 -0
- package/template/.agents/skills/idea-refine/examples.md +238 -0
- package/template/.agents/skills/idea-refine/frameworks.md +99 -0
- package/template/.agents/skills/idea-refine/refinement-criteria.md +113 -0
- package/template/.agents/skills/idea-refine/scripts/idea-refine.sh +15 -0
- package/template/.agents/skills/incremental-implementation/SKILL.md +248 -0
- package/template/.agents/skills/insight/SKILL.md +131 -0
- package/template/.agents/skills/insight-capture/SKILL.md +84 -0
- package/template/.agents/skills/intelligent-routing/SKILL.md +176 -0
- package/template/.agents/skills/issue-triage/SKILL.md +115 -0
- package/template/.agents/skills/lint-and-validate/SKILL.md +45 -0
- package/template/.agents/skills/lint-and-validate/scripts/lint_runner.py +184 -0
- package/template/.agents/skills/lint-and-validate/scripts/type_coverage.py +173 -0
- package/template/.agents/skills/mcp-builder/SKILL.md +176 -0
- package/template/.agents/skills/md2html/SKILL.md +154 -0
- package/template/.agents/skills/md2html/components.md +505 -0
- package/template/.agents/skills/md2html/template.html +1152 -0
- package/template/.agents/skills/merge/SKILL.md +76 -0
- package/template/.agents/skills/mobile-design/SKILL.md +394 -0
- package/template/.agents/skills/mobile-design/decision-trees.md +516 -0
- package/template/.agents/skills/mobile-design/mobile-backend.md +491 -0
- package/template/.agents/skills/mobile-design/mobile-color-system.md +420 -0
- package/template/.agents/skills/mobile-design/mobile-debugging.md +122 -0
- package/template/.agents/skills/mobile-design/mobile-design-thinking.md +357 -0
- package/template/.agents/skills/mobile-design/mobile-navigation.md +458 -0
- package/template/.agents/skills/mobile-design/mobile-performance.md +767 -0
- package/template/.agents/skills/mobile-design/mobile-testing.md +356 -0
- package/template/.agents/skills/mobile-design/mobile-typography.md +433 -0
- package/template/.agents/skills/mobile-design/platform-android.md +666 -0
- package/template/.agents/skills/mobile-design/platform-ios.md +561 -0
- package/template/.agents/skills/mobile-design/scripts/mobile_audit.py +670 -0
- package/template/.agents/skills/mobile-design/touch-psychology.md +537 -0
- package/template/.agents/skills/nextjs-react-expert/1-async-eliminating-waterfalls.md +312 -0
- package/template/.agents/skills/nextjs-react-expert/2-bundle-bundle-size-optimization.md +240 -0
- package/template/.agents/skills/nextjs-react-expert/3-server-server-side-performance.md +490 -0
- package/template/.agents/skills/nextjs-react-expert/4-client-client-side-data-fetching.md +264 -0
- package/template/.agents/skills/nextjs-react-expert/5-rerender-re-render-optimization.md +581 -0
- package/template/.agents/skills/nextjs-react-expert/6-rendering-rendering-performance.md +432 -0
- package/template/.agents/skills/nextjs-react-expert/7-js-javascript-performance.md +684 -0
- package/template/.agents/skills/nextjs-react-expert/8-advanced-advanced-patterns.md +150 -0
- package/template/.agents/skills/nextjs-react-expert/SKILL.md +286 -0
- package/template/.agents/skills/nextjs-react-expert/scripts/convert_rules.py +222 -0
- package/template/.agents/skills/nextjs-react-expert/scripts/react_performance_checker.py +252 -0
- package/template/.agents/skills/nodejs-best-practices/SKILL.md +333 -0
- package/template/.agents/skills/obsidian-bases/SKILL.md +506 -0
- package/template/.agents/skills/obsidian-bases/references/FUNCTIONS_REFERENCE.md +173 -0
- package/template/.agents/skills/obsidian-cli/SKILL.md +115 -0
- package/template/.agents/skills/obsidian-clipper-template-creator/SKILL.md +73 -0
- package/template/.agents/skills/obsidian-clipper-template-creator/assets/clipping-template.json +51 -0
- package/template/.agents/skills/obsidian-clipper-template-creator/assets/recipe-template.json +48 -0
- package/template/.agents/skills/obsidian-clipper-template-creator/references/analysis-workflow.md +79 -0
- package/template/.agents/skills/obsidian-clipper-template-creator/references/bases-workflow.md +44 -0
- package/template/.agents/skills/obsidian-clipper-template-creator/references/filters.md +51 -0
- package/template/.agents/skills/obsidian-clipper-template-creator/references/json-schema.md +77 -0
- package/template/.agents/skills/obsidian-clipper-template-creator/references/logic.md +67 -0
- package/template/.agents/skills/obsidian-clipper-template-creator/references/variables.md +64 -0
- package/template/.agents/skills/obsidian-markdown/SKILL.md +205 -0
- package/template/.agents/skills/obsidian-markdown/references/CALLOUTS.md +58 -0
- package/template/.agents/skills/obsidian-markdown/references/EMBEDS.md +63 -0
- package/template/.agents/skills/obsidian-markdown/references/PROPERTIES.md +61 -0
- package/template/.agents/skills/package-json-generator/SKILL.md +60 -0
- package/template/.agents/skills/package-json-generator/scripts/generate.js +120 -0
- package/template/.agents/skills/package-json-generator/scripts/run.sh +19 -0
- package/template/.agents/skills/parallel-agents/SKILL.md +144 -0
- package/template/.agents/skills/performance-optimization/SKILL.md +299 -0
- package/template/.agents/skills/performance-optimization/performance-checklist.md +113 -0
- package/template/.agents/skills/planning-and-task-breakdown/SKILL.md +239 -0
- package/template/.agents/skills/powershell-windows/SKILL.md +167 -0
- package/template/.agents/skills/pr/SKILL.md +93 -0
- package/template/.agents/skills/pr-review/SKILL.md +143 -0
- package/template/.agents/skills/pr-review-analysis/SKILL.md +89 -0
- package/template/.agents/skills/prd/SKILL.md +127 -0
- package/template/.agents/skills/preview/SKILL.md +121 -0
- package/template/.agents/skills/preview-local-check/SKILL.md +59 -0
- package/template/.agents/skills/prompt-addons/SKILL.md +99 -0
- package/template/.agents/skills/prototype/SKILL.md +44 -0
- package/template/.agents/skills/prp-dev-fastapi/SKILL.md +114 -0
- package/template/.agents/skills/prp-dev-multiplatform/SKILL.md +36 -0
- package/template/.agents/skills/prp-dev-odoo/SKILL.md +71 -0
- package/template/.agents/skills/prp-dev-php/SKILL.md +63 -0
- package/template/.agents/skills/prp-sa-ba/SKILL.md +52 -0
- package/template/.agents/skills/python-patterns/SKILL.md +441 -0
- package/template/.agents/skills/red-team-tactics/SKILL.md +199 -0
- package/template/.agents/skills/release-git-operations/SKILL.md +97 -0
- package/template/.agents/skills/research/SKILL.md +143 -0
- package/template/.agents/skills/review/SKILL.md +55 -0
- package/template/.agents/skills/review-followup-routing/SKILL.md +98 -0
- package/template/.agents/skills/roadmap-strategy/SKILL.md +97 -0
- package/template/.agents/skills/security-and-hardening/SKILL.md +349 -0
- package/template/.agents/skills/security-and-hardening/security-checklist.md +134 -0
- package/template/.agents/skills/security-review/SKILL.md +166 -0
- package/template/.agents/skills/seo-fundamentals/SKILL.md +129 -0
- package/template/.agents/skills/seo-fundamentals/scripts/seo_checker.py +219 -0
- package/template/.agents/skills/server-management/SKILL.md +161 -0
- package/template/.agents/skills/shipping-and-launch/SKILL.md +311 -0
- package/template/.agents/skills/silent-failure-audit/SKILL.md +73 -0
- package/template/.agents/skills/simplify/SKILL.md +79 -0
- package/template/.agents/skills/skill-development/SKILL.md +86 -0
- package/template/.agents/skills/spec-driven-development/SKILL.md +207 -0
- package/template/.agents/skills/spec-orchestration/SKILL.md +91 -0
- package/template/.agents/skills/specialist-agent-routing/SKILL.md +107 -0
- package/template/.agents/skills/tailwind-patterns/SKILL.md +269 -0
- package/template/.agents/skills/test/SKILL.md +82 -0
- package/template/.agents/skills/test-driven-development/SKILL.md +422 -0
- package/template/.agents/skills/test-driven-development/testing-patterns.md +236 -0
- package/template/.agents/skills/test-execution-and-coverage/SKILL.md +56 -0
- package/template/.agents/skills/type-design/SKILL.md +84 -0
- package/template/.agents/skills/ui-ux-pro-max/SKILL.md +75 -0
- package/template/.agents/skills/using-agent-skills/SKILL.md +171 -0
- package/template/.agents/skills/verification-orchestration/SKILL.md +68 -0
- package/template/.agents/skills/vulnerability-scanner/SKILL.md +276 -0
- package/template/.agents/skills/vulnerability-scanner/checklists.md +121 -0
- package/template/.agents/skills/vulnerability-scanner/scripts/security_scan.py +458 -0
- package/template/.agents/skills/wiki/SKILL.md +149 -0
- package/template/.agents/skills/workflow-documentation-sync/SKILL.md +87 -0
- package/template/.agents/skills/writing-great-skills/SKILL.md +65 -0
- package/template/.claude/skills/00-discover/SKILL.md +170 -0
- package/template/.claude/skills/10-define/SKILL.md +170 -0
- package/template/.claude/skills/20-spec/SKILL.md +156 -0
- package/template/.claude/skills/30-plan/SKILL.md +221 -0
- package/template/.claude/skills/40-implement/SKILL.md +166 -0
- package/template/.claude/skills/50-verify/SKILL.md +188 -0
- package/template/.claude/skills/60-report/SKILL.md +183 -0
- package/template/.claude/skills/70-release/SKILL.md +155 -0
- package/template/.claude/skills/9arm-skills/README.md +51 -0
- package/template/.claude/skills/9arm-skills/debug-mantra/SKILL.md +86 -0
- package/template/.claude/skills/9arm-skills/management-talk/SKILL.md +79 -0
- package/template/.claude/skills/9arm-skills/post-mortem/SKILL.md +71 -0
- package/template/.claude/skills/9arm-skills/scrutinize/SKILL.md +72 -0
- package/template/.claude/skills/agent/SKILL.md +165 -0
- package/template/.claude/skills/api-and-interface-design/SKILL.md +294 -0
- package/template/.claude/skills/app-builder/SKILL.md +75 -0
- package/template/.claude/skills/app-builder/agent-coordination.md +71 -0
- package/template/.claude/skills/app-builder/feature-building.md +53 -0
- package/template/.claude/skills/app-builder/project-detection.md +34 -0
- package/template/.claude/skills/app-builder/scaffolding.md +118 -0
- package/template/.claude/skills/app-builder/tech-stack.md +40 -0
- package/template/.claude/skills/app-builder/templates/SKILL.md +39 -0
- package/template/.claude/skills/app-builder/templates/astro-static/TEMPLATE.md +76 -0
- package/template/.claude/skills/app-builder/templates/chrome-extension/TEMPLATE.md +92 -0
- package/template/.claude/skills/app-builder/templates/cli-tool/TEMPLATE.md +88 -0
- package/template/.claude/skills/app-builder/templates/electron-desktop/TEMPLATE.md +88 -0
- package/template/.claude/skills/app-builder/templates/express-api/TEMPLATE.md +83 -0
- package/template/.claude/skills/app-builder/templates/flutter-app/TEMPLATE.md +90 -0
- package/template/.claude/skills/app-builder/templates/monorepo-turborepo/TEMPLATE.md +90 -0
- package/template/.claude/skills/app-builder/templates/nextjs-fullstack/TEMPLATE.md +122 -0
- package/template/.claude/skills/app-builder/templates/nextjs-saas/TEMPLATE.md +122 -0
- package/template/.claude/skills/app-builder/templates/nextjs-static/TEMPLATE.md +169 -0
- package/template/.claude/skills/app-builder/templates/nuxt-app/TEMPLATE.md +134 -0
- package/template/.claude/skills/app-builder/templates/python-fastapi/TEMPLATE.md +83 -0
- package/template/.claude/skills/app-builder/templates/react-native-app/TEMPLATE.md +119 -0
- package/template/.claude/skills/architecture/SKILL.md +55 -0
- package/template/.claude/skills/architecture/context-discovery.md +43 -0
- package/template/.claude/skills/architecture/examples.md +94 -0
- package/template/.claude/skills/architecture/pattern-selection.md +68 -0
- package/template/.claude/skills/architecture/patterns-reference.md +50 -0
- package/template/.claude/skills/architecture/trade-off-analysis.md +77 -0
- package/template/.claude/skills/bash-linux/SKILL.md +199 -0
- package/template/.claude/skills/behavioral-modes/SKILL.md +242 -0
- package/template/.claude/skills/brainstorm/SKILL.md +168 -0
- package/template/.claude/skills/browser-testing-with-devtools/SKILL.md +302 -0
- package/template/.claude/skills/changelog/SKILL.md +109 -0
- package/template/.claude/skills/check-for-updates/SKILL.md +117 -0
- package/template/.claude/skills/ci-cd-and-automation/SKILL.md +390 -0
- package/template/.claude/skills/code-review-and-quality/SKILL.md +392 -0
- package/template/.claude/skills/code-simplification/SKILL.md +331 -0
- package/template/.claude/skills/codebase-design/DEEPENING.md +24 -0
- package/template/.claude/skills/codebase-design/DESIGN-IT-TWICE.md +28 -0
- package/template/.claude/skills/codebase-design/SKILL.md +58 -0
- package/template/.claude/skills/commit/SKILL.md +63 -0
- package/template/.claude/skills/competitor-analysis/SKILL.md +66 -0
- package/template/.claude/skills/context-engineering/SKILL.md +290 -0
- package/template/.claude/skills/database-design/SKILL.md +52 -0
- package/template/.claude/skills/database-design/database-selection.md +43 -0
- package/template/.claude/skills/database-design/indexing.md +39 -0
- package/template/.claude/skills/database-design/migrations.md +48 -0
- package/template/.claude/skills/database-design/optimization.md +36 -0
- package/template/.claude/skills/database-design/orm-selection.md +30 -0
- package/template/.claude/skills/database-design/schema-design.md +56 -0
- package/template/.claude/skills/database-design/scripts/schema_validator.py +172 -0
- package/template/.claude/skills/debug/SKILL.md +131 -0
- package/template/.claude/skills/debugging-and-error-recovery/SKILL.md +298 -0
- package/template/.claude/skills/deploy/SKILL.md +91 -0
- package/template/.claude/skills/deployment-procedures/SKILL.md +241 -0
- package/template/.claude/skills/deprecation-and-migration/SKILL.md +206 -0
- package/template/.claude/skills/devflow/SKILL.md +89 -0
- package/template/.claude/skills/devflow-concept-intake/SKILL.md +150 -0
- package/template/.claude/skills/devflow-concept-intake/agents/openai.yaml +4 -0
- package/template/.claude/skills/devflow-concept-intake/references/adoption-proposal-template.md +60 -0
- package/template/.claude/skills/devflow-concept-intake/references/concept-report-template.md +47 -0
- package/template/.claude/skills/devflow-concept-intake/references/upstream-tracking-template.md +51 -0
- package/template/.claude/skills/devflow-wiki/SKILL.md +75 -0
- package/template/.claude/skills/diagnosing-bugs/SKILL.md +93 -0
- package/template/.claude/skills/documentation-and-adrs/SKILL.md +278 -0
- package/template/.claude/skills/domain-modeling/ADR-FORMAT.md +47 -0
- package/template/.claude/skills/domain-modeling/CONTEXT-FORMAT.md +60 -0
- package/template/.claude/skills/domain-modeling/SKILL.md +74 -0
- package/template/.claude/skills/english-to-thai-translator/SKILL.md +125 -0
- package/template/.claude/skills/followup/SKILL.md +83 -0
- package/template/.claude/skills/frontend-ui-engineering/SKILL.md +326 -0
- package/template/.claude/skills/frontend-ui-engineering/accessibility-checklist.md +159 -0
- package/template/.claude/skills/git-workflow-and-versioning/SKILL.md +300 -0
- package/template/.claude/skills/goal/SKILL.md +148 -0
- package/template/.claude/skills/handoff/SKILL.md +46 -0
- package/template/.claude/skills/help/SKILL.md +253 -0
- package/template/.claude/skills/human-review-decisions/SKILL.md +74 -0
- package/template/.claude/skills/i18n-localization/SKILL.md +154 -0
- package/template/.claude/skills/i18n-localization/scripts/i18n_checker.py +241 -0
- package/template/.claude/skills/idea-refine/SKILL.md +178 -0
- package/template/.claude/skills/idea-refine/examples.md +238 -0
- package/template/.claude/skills/idea-refine/frameworks.md +99 -0
- package/template/.claude/skills/idea-refine/refinement-criteria.md +113 -0
- package/template/.claude/skills/idea-refine/scripts/idea-refine.sh +15 -0
- package/template/.claude/skills/incremental-implementation/SKILL.md +248 -0
- package/template/.claude/skills/insight/SKILL.md +131 -0
- package/template/.claude/skills/insight-capture/SKILL.md +84 -0
- package/template/.claude/skills/intelligent-routing/SKILL.md +176 -0
- package/template/.claude/skills/issue-triage/SKILL.md +115 -0
- package/template/.claude/skills/lint-and-validate/SKILL.md +45 -0
- package/template/.claude/skills/lint-and-validate/scripts/lint_runner.py +184 -0
- package/template/.claude/skills/lint-and-validate/scripts/type_coverage.py +173 -0
- package/template/.claude/skills/mcp-builder/SKILL.md +176 -0
- package/template/.claude/skills/md2html/SKILL.md +154 -0
- package/template/.claude/skills/md2html/components.md +505 -0
- package/template/.claude/skills/md2html/template.html +1152 -0
- package/template/.claude/skills/merge/SKILL.md +76 -0
- package/template/.claude/skills/mobile-design/SKILL.md +394 -0
- package/template/.claude/skills/mobile-design/decision-trees.md +516 -0
- package/template/.claude/skills/mobile-design/mobile-backend.md +491 -0
- package/template/.claude/skills/mobile-design/mobile-color-system.md +420 -0
- package/template/.claude/skills/mobile-design/mobile-debugging.md +122 -0
- package/template/.claude/skills/mobile-design/mobile-design-thinking.md +357 -0
- package/template/.claude/skills/mobile-design/mobile-navigation.md +458 -0
- package/template/.claude/skills/mobile-design/mobile-performance.md +767 -0
- package/template/.claude/skills/mobile-design/mobile-testing.md +356 -0
- package/template/.claude/skills/mobile-design/mobile-typography.md +433 -0
- package/template/.claude/skills/mobile-design/platform-android.md +666 -0
- package/template/.claude/skills/mobile-design/platform-ios.md +561 -0
- package/template/.claude/skills/mobile-design/scripts/mobile_audit.py +670 -0
- package/template/.claude/skills/mobile-design/touch-psychology.md +537 -0
- package/template/.claude/skills/nextjs-react-expert/1-async-eliminating-waterfalls.md +312 -0
- package/template/.claude/skills/nextjs-react-expert/2-bundle-bundle-size-optimization.md +240 -0
- package/template/.claude/skills/nextjs-react-expert/3-server-server-side-performance.md +490 -0
- package/template/.claude/skills/nextjs-react-expert/4-client-client-side-data-fetching.md +264 -0
- package/template/.claude/skills/nextjs-react-expert/5-rerender-re-render-optimization.md +581 -0
- package/template/.claude/skills/nextjs-react-expert/6-rendering-rendering-performance.md +432 -0
- package/template/.claude/skills/nextjs-react-expert/7-js-javascript-performance.md +684 -0
- package/template/.claude/skills/nextjs-react-expert/8-advanced-advanced-patterns.md +150 -0
- package/template/.claude/skills/nextjs-react-expert/SKILL.md +286 -0
- package/template/.claude/skills/nextjs-react-expert/scripts/convert_rules.py +222 -0
- package/template/.claude/skills/nextjs-react-expert/scripts/react_performance_checker.py +252 -0
- package/template/.claude/skills/nodejs-best-practices/SKILL.md +333 -0
- package/template/.claude/skills/obsidian-bases/SKILL.md +506 -0
- package/template/.claude/skills/obsidian-bases/references/FUNCTIONS_REFERENCE.md +173 -0
- package/template/.claude/skills/obsidian-cli/SKILL.md +115 -0
- package/template/.claude/skills/obsidian-clipper-template-creator/SKILL.md +73 -0
- package/template/.claude/skills/obsidian-clipper-template-creator/assets/clipping-template.json +51 -0
- package/template/.claude/skills/obsidian-clipper-template-creator/assets/recipe-template.json +48 -0
- package/template/.claude/skills/obsidian-clipper-template-creator/references/analysis-workflow.md +79 -0
- package/template/.claude/skills/obsidian-clipper-template-creator/references/bases-workflow.md +44 -0
- package/template/.claude/skills/obsidian-clipper-template-creator/references/filters.md +51 -0
- package/template/.claude/skills/obsidian-clipper-template-creator/references/json-schema.md +77 -0
- package/template/.claude/skills/obsidian-clipper-template-creator/references/logic.md +67 -0
- package/template/.claude/skills/obsidian-clipper-template-creator/references/variables.md +64 -0
- package/template/.claude/skills/obsidian-markdown/SKILL.md +205 -0
- package/template/.claude/skills/obsidian-markdown/references/CALLOUTS.md +58 -0
- package/template/.claude/skills/obsidian-markdown/references/EMBEDS.md +63 -0
- package/template/.claude/skills/obsidian-markdown/references/PROPERTIES.md +61 -0
- package/template/.claude/skills/package-json-generator/SKILL.md +60 -0
- package/template/.claude/skills/package-json-generator/scripts/generate.js +120 -0
- package/template/.claude/skills/package-json-generator/scripts/run.sh +19 -0
- package/template/.claude/skills/parallel-agents/SKILL.md +144 -0
- package/template/.claude/skills/performance-optimization/SKILL.md +299 -0
- package/template/.claude/skills/performance-optimization/performance-checklist.md +113 -0
- package/template/.claude/skills/planning-and-task-breakdown/SKILL.md +239 -0
- package/template/.claude/skills/powershell-windows/SKILL.md +167 -0
- package/template/.claude/skills/pr/SKILL.md +93 -0
- package/template/.claude/skills/pr-review/SKILL.md +143 -0
- package/template/.claude/skills/pr-review-analysis/SKILL.md +89 -0
- package/template/.claude/skills/prd/SKILL.md +127 -0
- package/template/.claude/skills/preview/SKILL.md +121 -0
- package/template/.claude/skills/preview-local-check/SKILL.md +59 -0
- package/template/.claude/skills/prompt-addons/SKILL.md +99 -0
- package/template/.claude/skills/prototype/SKILL.md +44 -0
- package/template/.claude/skills/prp-dev-fastapi/SKILL.md +114 -0
- package/template/.claude/skills/prp-dev-multiplatform/SKILL.md +36 -0
- package/template/.claude/skills/prp-dev-odoo/SKILL.md +71 -0
- package/template/.claude/skills/prp-dev-php/SKILL.md +63 -0
- package/template/.claude/skills/prp-sa-ba/SKILL.md +52 -0
- package/template/.claude/skills/python-patterns/SKILL.md +441 -0
- package/template/.claude/skills/red-team-tactics/SKILL.md +199 -0
- package/template/.claude/skills/release-git-operations/SKILL.md +97 -0
- package/template/.claude/skills/research/SKILL.md +143 -0
- package/template/.claude/skills/review/SKILL.md +55 -0
- package/template/.claude/skills/review-followup-routing/SKILL.md +98 -0
- package/template/.claude/skills/roadmap-strategy/SKILL.md +97 -0
- package/template/.claude/skills/security-and-hardening/SKILL.md +349 -0
- package/template/.claude/skills/security-and-hardening/security-checklist.md +134 -0
- package/template/.claude/skills/security-review/SKILL.md +166 -0
- package/template/.claude/skills/seo-fundamentals/SKILL.md +129 -0
- package/template/.claude/skills/seo-fundamentals/scripts/seo_checker.py +219 -0
- package/template/.claude/skills/server-management/SKILL.md +161 -0
- package/template/.claude/skills/shipping-and-launch/SKILL.md +311 -0
- package/template/.claude/skills/silent-failure-audit/SKILL.md +73 -0
- package/template/.claude/skills/simplify/SKILL.md +79 -0
- package/template/.claude/skills/skill-development/SKILL.md +86 -0
- package/template/.claude/skills/spec-driven-development/SKILL.md +207 -0
- package/template/.claude/skills/spec-orchestration/SKILL.md +91 -0
- package/template/.claude/skills/specialist-agent-routing/SKILL.md +107 -0
- package/template/.claude/skills/tailwind-patterns/SKILL.md +269 -0
- package/template/.claude/skills/test/SKILL.md +82 -0
- package/template/.claude/skills/test-driven-development/SKILL.md +422 -0
- package/template/.claude/skills/test-driven-development/testing-patterns.md +236 -0
- package/template/.claude/skills/test-execution-and-coverage/SKILL.md +56 -0
- package/template/.claude/skills/type-design/SKILL.md +84 -0
- package/template/.claude/skills/ui-ux-pro-max/SKILL.md +75 -0
- package/template/.claude/skills/using-agent-skills/SKILL.md +171 -0
- package/template/.claude/skills/verification-orchestration/SKILL.md +68 -0
- package/template/.claude/skills/vulnerability-scanner/SKILL.md +276 -0
- package/template/.claude/skills/vulnerability-scanner/checklists.md +121 -0
- package/template/.claude/skills/vulnerability-scanner/scripts/security_scan.py +458 -0
- package/template/.claude/skills/wiki/SKILL.md +149 -0
- package/template/.claude/skills/workflow-documentation-sync/SKILL.md +87 -0
- package/template/.claude/skills/writing-great-skills/SKILL.md +65 -0
- package/template/.nexus/nexus-devflow.json +44 -0
- package/template/AGENTS.md +58 -0
- package/template/CLAUDE.md +5 -0
- package/template/LICENSE +21 -0
- package/template/devflow/context/ai-interaction.md +34 -0
- package/template/devflow/context/coding-standards.md +19 -0
- package/template/devflow/context/current-stage.md +6 -0
- package/template/devflow/context/findings.md +13 -0
- package/template/devflow/context/project-overview.md +20 -0
- package/template/devflow/reference/running-id-contract.md +39 -0
package/template/.claude/skills/devflow-concept-intake/references/adoption-proposal-template.md
ADDED
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
# Adoption Proposal Template
|
|
2
|
+
|
|
3
|
+
Use this template for phase 2 after the user agrees a concept is worth exploring.
|
|
4
|
+
|
|
5
|
+
```markdown
|
|
6
|
+
# DevFlow Adoption Proposal: {concept-name}
|
|
7
|
+
|
|
8
|
+
## Recommendation
|
|
9
|
+
|
|
10
|
+
Adopt | Adapt | Defer
|
|
11
|
+
|
|
12
|
+
## Why This Belongs In Nexus-DevFlow
|
|
13
|
+
|
|
14
|
+
Explain the value in terms of DevFlow goals: clearer agent behavior, safer workflow gates, better artifacts, stronger validation, or reusable knowledge.
|
|
15
|
+
|
|
16
|
+
## Target DevFlow Surface
|
|
17
|
+
|
|
18
|
+
| Surface | Change |
|
|
19
|
+
| :--- | :--- |
|
|
20
|
+
| Workflow | |
|
|
21
|
+
| Agent | |
|
|
22
|
+
| Skill | |
|
|
23
|
+
| Artifact | |
|
|
24
|
+
| Option guide | |
|
|
25
|
+
| Wiki/docs | |
|
|
26
|
+
|
|
27
|
+
## Smallest Useful Version
|
|
28
|
+
|
|
29
|
+
Describe the smallest change that proves the concept works inside DevFlow.
|
|
30
|
+
|
|
31
|
+
## What Changes
|
|
32
|
+
|
|
33
|
+
- Files or folders:
|
|
34
|
+
- Commands or workflows:
|
|
35
|
+
- Agent behavior:
|
|
36
|
+
- Artifacts:
|
|
37
|
+
- Validation:
|
|
38
|
+
|
|
39
|
+
## What Does Not Change
|
|
40
|
+
|
|
41
|
+
State core DevFlow behavior that must remain stable.
|
|
42
|
+
|
|
43
|
+
## Option Pack
|
|
44
|
+
|
|
45
|
+
Use this section only when concepts must be used together.
|
|
46
|
+
|
|
47
|
+
- Pack name:
|
|
48
|
+
- Required concepts:
|
|
49
|
+
- Optional concepts:
|
|
50
|
+
- Activation trigger:
|
|
51
|
+
- Do not use when:
|
|
52
|
+
|
|
53
|
+
## Risks And Rejection Criteria
|
|
54
|
+
|
|
55
|
+
List reasons to stop or roll back.
|
|
56
|
+
|
|
57
|
+
## Validation Plan
|
|
58
|
+
|
|
59
|
+
List exact checks, scripts, docs review, or test tasks needed before considering adoption complete.
|
|
60
|
+
```
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
# Concept Report Template
|
|
2
|
+
|
|
3
|
+
Use this template for phase 1: discussion-first repo or README study.
|
|
4
|
+
|
|
5
|
+
```markdown
|
|
6
|
+
# Concept Report: {source-name}
|
|
7
|
+
|
|
8
|
+
## Source
|
|
9
|
+
|
|
10
|
+
- Repo or document:
|
|
11
|
+
- Revision, tag, branch, or date checked:
|
|
12
|
+
- Files read:
|
|
13
|
+
- Source confidence: high | medium | low
|
|
14
|
+
|
|
15
|
+
## What The Source Is Trying To Do
|
|
16
|
+
|
|
17
|
+
Summarize the source in plain language. Separate the project's stated goal from your inference.
|
|
18
|
+
|
|
19
|
+
## Principles Found
|
|
20
|
+
|
|
21
|
+
| Principle | Evidence | Interpretation |
|
|
22
|
+
| :--- | :--- | :--- |
|
|
23
|
+
| | | |
|
|
24
|
+
|
|
25
|
+
## Decision Matrix
|
|
26
|
+
|
|
27
|
+
| Concept | Decision | Why | DevFlow Fit |
|
|
28
|
+
| :--- | :--- | :--- | :--- |
|
|
29
|
+
| | Adopt | | |
|
|
30
|
+
| | Adapt | | |
|
|
31
|
+
| | Reject | | |
|
|
32
|
+
| | Defer | | |
|
|
33
|
+
|
|
34
|
+
## Direct Critique
|
|
35
|
+
|
|
36
|
+
State what is strong, what is weak, what is overbuilt, what is missing, and what should not be copied into Nexus-DevFlow.
|
|
37
|
+
|
|
38
|
+
## Discussion Questions
|
|
39
|
+
|
|
40
|
+
-
|
|
41
|
+
-
|
|
42
|
+
-
|
|
43
|
+
|
|
44
|
+
## Recommended Next Step
|
|
45
|
+
|
|
46
|
+
Choose one: stop, discuss, write adoption proposal, create option pack, or track upstream.
|
|
47
|
+
```
|
package/template/.claude/skills/devflow-concept-intake/references/upstream-tracking-template.md
ADDED
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
# Upstream Tracking Template
|
|
2
|
+
|
|
3
|
+
Use this template for phase 3 only after the user chooses to adopt or actively evaluate a source concept.
|
|
4
|
+
|
|
5
|
+
```markdown
|
|
6
|
+
# Upstream Tracking: {source-name}
|
|
7
|
+
|
|
8
|
+
## Source
|
|
9
|
+
|
|
10
|
+
- Repo:
|
|
11
|
+
- Upstream revision:
|
|
12
|
+
- License:
|
|
13
|
+
- Credit:
|
|
14
|
+
- Date recorded:
|
|
15
|
+
|
|
16
|
+
## Adopted Or Evaluated Concepts
|
|
17
|
+
|
|
18
|
+
| Source Concept | Local DevFlow Mapping | Status |
|
|
19
|
+
| :--- | :--- | :--- |
|
|
20
|
+
| | | adopted | evaluating | rejected |
|
|
21
|
+
|
|
22
|
+
## Local Integration Points
|
|
23
|
+
|
|
24
|
+
- Workflows:
|
|
25
|
+
- Agents:
|
|
26
|
+
- Skills:
|
|
27
|
+
- Artifacts:
|
|
28
|
+
- Docs/wiki:
|
|
29
|
+
- Scripts:
|
|
30
|
+
|
|
31
|
+
## Update Strategy
|
|
32
|
+
|
|
33
|
+
Choose one:
|
|
34
|
+
|
|
35
|
+
- Manual review: revisit only when user asks.
|
|
36
|
+
- Scheduled review: revisit on a calendar or release cadence.
|
|
37
|
+
- Diff-based review: compare upstream changes against recorded revision.
|
|
38
|
+
- No tracking: preserve credit, but do not follow upstream.
|
|
39
|
+
|
|
40
|
+
## Compatibility Notes
|
|
41
|
+
|
|
42
|
+
Explain what could break if upstream changes, and what local decisions intentionally diverge from upstream.
|
|
43
|
+
|
|
44
|
+
## Review Checklist
|
|
45
|
+
|
|
46
|
+
- [ ] Compare upstream README or docs against recorded revision.
|
|
47
|
+
- [ ] Check whether adopted concepts changed meaning.
|
|
48
|
+
- [ ] Check whether local DevFlow mapping is still valid.
|
|
49
|
+
- [ ] Update adoption proposal or option guide if needed.
|
|
50
|
+
- [ ] Preserve credit and license notes.
|
|
51
|
+
```
|
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: devflow-wiki
|
|
3
|
+
description: Use when creating, updating, linting, querying, or deciding whether to ingest Nexus-DevFlow framework or project wiki knowledge under devflow/wiki.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# DevFlow Wiki
|
|
7
|
+
|
|
8
|
+
Use DevFlow Wiki to compile reusable knowledge from source artifacts into small, source-backed Markdown pages.
|
|
9
|
+
|
|
10
|
+
## Core Rules
|
|
11
|
+
|
|
12
|
+
- Treat wiki pages as compiled knowledge, not source truth.
|
|
13
|
+
- Keep `framework` and `project` namespaces separate.
|
|
14
|
+
- Include `## Sources` on every page.
|
|
15
|
+
- Use `_drafts/` for generated or unreviewed project pages.
|
|
16
|
+
- Prefer one focused page over broad rewrites.
|
|
17
|
+
- Do not ingest noisy logs, unverified hypotheses, or routine edits with no reusable lesson.
|
|
18
|
+
|
|
19
|
+
## Namespace Decision
|
|
20
|
+
|
|
21
|
+
| Scope | Use For | Path |
|
|
22
|
+
| :--- | :--- | :--- |
|
|
23
|
+
| `framework` | DevFlow workflows, agents, commands, install behavior, output contracts, token/context rules | `devflow/wiki/framework/` |
|
|
24
|
+
| `project` | Target project architecture, domain concepts, decisions, patterns, gotchas, task lessons | `devflow/wiki/project/` |
|
|
25
|
+
|
|
26
|
+
Promote project pages to framework only when the lesson applies beyond one project.
|
|
27
|
+
|
|
28
|
+
## Commands
|
|
29
|
+
|
|
30
|
+
Initialize and maintain wiki pages through the documented markdown structure under `devflow/wiki/`. Do not rely on the retired PRP runtime for wiki commands.
|
|
31
|
+
|
|
32
|
+
Use `Wiki {scope} ingest {source}` for workflow-level ingestion and route reporting.
|
|
33
|
+
|
|
34
|
+
## Project Wiki Contract
|
|
35
|
+
|
|
36
|
+
Every project wiki uses:
|
|
37
|
+
|
|
38
|
+
```text
|
|
39
|
+
devflow/wiki/project/
|
|
40
|
+
|-- index.md
|
|
41
|
+
|-- architecture/
|
|
42
|
+
|-- decisions/
|
|
43
|
+
|-- domain/
|
|
44
|
+
|-- gotchas/
|
|
45
|
+
|-- patterns/
|
|
46
|
+
|-- tasks/
|
|
47
|
+
|-- token-context/
|
|
48
|
+
`-- _drafts/
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
Each published page should follow `.agent/resources/schemas/wiki_page.template.md`.
|
|
52
|
+
|
|
53
|
+
## Ingest Heuristics
|
|
54
|
+
|
|
55
|
+
Ingest when the source contains reusable knowledge:
|
|
56
|
+
|
|
57
|
+
- verified QA evidence
|
|
58
|
+
- confirmed root cause and prevention
|
|
59
|
+
- durable project decision
|
|
60
|
+
- stable architecture or domain concept
|
|
61
|
+
- repeated gotcha or risk pattern
|
|
62
|
+
- context/token optimization lesson
|
|
63
|
+
|
|
64
|
+
Skip ingest when the source is one-off, unverified, noisy, or already represented in a focused page.
|
|
65
|
+
|
|
66
|
+
## Output Expectation
|
|
67
|
+
|
|
68
|
+
Always report:
|
|
69
|
+
|
|
70
|
+
- pages created or updated
|
|
71
|
+
- source artifacts used
|
|
72
|
+
- lint result or remaining issue
|
|
73
|
+
- next workflow recommendation
|
|
74
|
+
- wiki update recommendation
|
|
75
|
+
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: diagnosing-bugs
|
|
3
|
+
description: Diagnosis loop for hard bugs and performance regressions. Use inside Debug, /40-Implement, or /50-Verify when behavior is broken, throwing, failing, flaky, or slow.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Diagnosing Bugs
|
|
7
|
+
|
|
8
|
+
Use this support skill when the active DevFlow owner needs a disciplined root-cause loop.
|
|
9
|
+
|
|
10
|
+
Do not let this skill replace `Debug`, `/40-Implement`, or `/50-Verify`. It supplies the method; the owning workflow records the artifact.
|
|
11
|
+
|
|
12
|
+
## Phase 1: Build A Tight Feedback Loop
|
|
13
|
+
|
|
14
|
+
Before hypothesizing, create a command or repeatable action that can catch the exact symptom.
|
|
15
|
+
|
|
16
|
+
Preferred loops:
|
|
17
|
+
|
|
18
|
+
1. failing automated test
|
|
19
|
+
2. CLI command with fixture input
|
|
20
|
+
3. HTTP request or curl script
|
|
21
|
+
4. browser automation
|
|
22
|
+
5. captured trace replay
|
|
23
|
+
6. throwaway harness
|
|
24
|
+
7. property or stress loop
|
|
25
|
+
8. bisection loop
|
|
26
|
+
9. differential loop
|
|
27
|
+
10. structured human-in-the-loop notes when automation is impossible
|
|
28
|
+
|
|
29
|
+
The loop must be:
|
|
30
|
+
|
|
31
|
+
- red-capable for the user's exact symptom
|
|
32
|
+
- deterministic, or high-reproduction-rate for flaky bugs
|
|
33
|
+
- fast enough to run repeatedly
|
|
34
|
+
- runnable by an agent or explicitly documented when human input is required
|
|
35
|
+
|
|
36
|
+
If no loop can be built, stop and ask for missing artifacts such as logs, HAR files, screen recordings, production access, or permission for temporary instrumentation.
|
|
37
|
+
|
|
38
|
+
## Phase 2: Reproduce And Minimize
|
|
39
|
+
|
|
40
|
+
Run the loop and confirm it reproduces the described symptom.
|
|
41
|
+
|
|
42
|
+
Then minimize:
|
|
43
|
+
|
|
44
|
+
- reduce inputs
|
|
45
|
+
- reduce configuration
|
|
46
|
+
- reduce steps
|
|
47
|
+
- remove dependencies one at a time
|
|
48
|
+
|
|
49
|
+
Stop minimizing only when every remaining element is load-bearing.
|
|
50
|
+
|
|
51
|
+
## Phase 3: Hypothesize
|
|
52
|
+
|
|
53
|
+
Write 3-5 ranked, falsifiable hypotheses.
|
|
54
|
+
|
|
55
|
+
Each hypothesis must say:
|
|
56
|
+
|
|
57
|
+
```text
|
|
58
|
+
If <cause> is true, then <probe or change> should produce <observable result>.
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
Proceed with the best hypothesis when user input is unavailable, but keep the ranked list in the artifact.
|
|
62
|
+
|
|
63
|
+
## Phase 4: Instrument
|
|
64
|
+
|
|
65
|
+
Probe one variable at a time.
|
|
66
|
+
|
|
67
|
+
- Prefer debugger or REPL inspection when available.
|
|
68
|
+
- Use targeted logs only at boundaries that distinguish hypotheses.
|
|
69
|
+
- Tag temporary logs with a unique prefix such as `[DEBUG-a4f2]`.
|
|
70
|
+
- For performance bugs, establish a measurement baseline before changing code.
|
|
71
|
+
|
|
72
|
+
## Phase 5: Fix And Guard
|
|
73
|
+
|
|
74
|
+
When a correct test seam exists:
|
|
75
|
+
|
|
76
|
+
1. Convert the minimized repro into a failing regression test.
|
|
77
|
+
2. Watch it fail.
|
|
78
|
+
3. Apply the fix.
|
|
79
|
+
4. Watch it pass.
|
|
80
|
+
5. Re-run the original feedback loop.
|
|
81
|
+
|
|
82
|
+
If no correct seam exists, record that architecture finding and route to `codebase-design` or `/30-Plan` after the bug is fixed.
|
|
83
|
+
|
|
84
|
+
## Phase 6: Cleanup And Post-Mortem
|
|
85
|
+
|
|
86
|
+
Before reporting done:
|
|
87
|
+
|
|
88
|
+
- original repro no longer reproduces
|
|
89
|
+
- regression test passes, or missing test seam is documented
|
|
90
|
+
- temporary debug instrumentation is removed
|
|
91
|
+
- throwaway harnesses are deleted or clearly marked
|
|
92
|
+
- root cause is recorded in the owning stage artifact
|
|
93
|
+
- prevention follow-up is captured when useful
|
|
@@ -0,0 +1,278 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: documentation-and-adrs
|
|
3
|
+
description: Records decisions and documentation. Use when making architectural decisions, changing public APIs, shipping features, or when you need to record context that future engineers and agents will need to understand the codebase.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Documentation and ADRs
|
|
7
|
+
|
|
8
|
+
## Overview
|
|
9
|
+
|
|
10
|
+
Document decisions, not just code. The most valuable documentation captures the *why* — the context, constraints, and trade-offs that led to a decision. Code shows *what* was built; documentation explains *why it was built this way* and *what alternatives were considered*. This context is essential for future humans and agents working in the codebase.
|
|
11
|
+
|
|
12
|
+
## When to Use
|
|
13
|
+
|
|
14
|
+
- Making a significant architectural decision
|
|
15
|
+
- Choosing between competing approaches
|
|
16
|
+
- Adding or changing a public API
|
|
17
|
+
- Shipping a feature that changes user-facing behavior
|
|
18
|
+
- Onboarding new team members (or agents) to the project
|
|
19
|
+
- When you find yourself explaining the same thing repeatedly
|
|
20
|
+
|
|
21
|
+
**When NOT to use:** Don't document obvious code. Don't add comments that restate what the code already says. Don't write docs for throwaway prototypes.
|
|
22
|
+
|
|
23
|
+
## Architecture Decision Records (ADRs)
|
|
24
|
+
|
|
25
|
+
ADRs capture the reasoning behind significant technical decisions. They're the highest-value documentation you can write.
|
|
26
|
+
|
|
27
|
+
### When to Write an ADR
|
|
28
|
+
|
|
29
|
+
- Choosing a framework, library, or major dependency
|
|
30
|
+
- Designing a data model or database schema
|
|
31
|
+
- Selecting an authentication strategy
|
|
32
|
+
- Deciding on an API architecture (REST vs. GraphQL vs. tRPC)
|
|
33
|
+
- Choosing between build tools, hosting platforms, or infrastructure
|
|
34
|
+
- Any decision that would be expensive to reverse
|
|
35
|
+
|
|
36
|
+
### ADR Template
|
|
37
|
+
|
|
38
|
+
Store ADRs in `docs/decisions/` with sequential numbering:
|
|
39
|
+
|
|
40
|
+
```markdown
|
|
41
|
+
# ADR-001: Use PostgreSQL for primary database
|
|
42
|
+
|
|
43
|
+
## Status
|
|
44
|
+
Accepted | Superseded by ADR-XXX | Deprecated
|
|
45
|
+
|
|
46
|
+
## Date
|
|
47
|
+
2025-01-15
|
|
48
|
+
|
|
49
|
+
## Context
|
|
50
|
+
We need a primary database for the task management application. Key requirements:
|
|
51
|
+
- Relational data model (users, tasks, teams with relationships)
|
|
52
|
+
- ACID transactions for task state changes
|
|
53
|
+
- Support for full-text search on task content
|
|
54
|
+
- Managed hosting available (for small team, limited ops capacity)
|
|
55
|
+
|
|
56
|
+
## Decision
|
|
57
|
+
Use PostgreSQL with Prisma ORM.
|
|
58
|
+
|
|
59
|
+
## Alternatives Considered
|
|
60
|
+
|
|
61
|
+
### MongoDB
|
|
62
|
+
- Pros: Flexible schema, easy to start with
|
|
63
|
+
- Cons: Our data is inherently relational; would need to manage relationships manually
|
|
64
|
+
- Rejected: Relational data in a document store leads to complex joins or data duplication
|
|
65
|
+
|
|
66
|
+
### SQLite
|
|
67
|
+
- Pros: Zero configuration, embedded, fast for reads
|
|
68
|
+
- Cons: Limited concurrent write support, no managed hosting for production
|
|
69
|
+
- Rejected: Not suitable for multi-user web application in production
|
|
70
|
+
|
|
71
|
+
### MySQL
|
|
72
|
+
- Pros: Mature, widely supported
|
|
73
|
+
- Cons: PostgreSQL has better JSON support, full-text search, and ecosystem tooling
|
|
74
|
+
- Rejected: PostgreSQL is the better fit for our feature requirements
|
|
75
|
+
|
|
76
|
+
## Consequences
|
|
77
|
+
- Prisma provides type-safe database access and migration management
|
|
78
|
+
- We can use PostgreSQL's full-text search instead of adding Elasticsearch
|
|
79
|
+
- Team needs PostgreSQL knowledge (standard skill, low risk)
|
|
80
|
+
- Hosting on managed service (Supabase, Neon, or RDS)
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
### ADR Lifecycle
|
|
84
|
+
|
|
85
|
+
```
|
|
86
|
+
PROPOSED → ACCEPTED → (SUPERSEDED or DEPRECATED)
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
- **Don't delete old ADRs.** They capture historical context.
|
|
90
|
+
- When a decision changes, write a new ADR that references and supersedes the old one.
|
|
91
|
+
|
|
92
|
+
## Inline Documentation
|
|
93
|
+
|
|
94
|
+
### When to Comment
|
|
95
|
+
|
|
96
|
+
Comment the *why*, not the *what*:
|
|
97
|
+
|
|
98
|
+
```typescript
|
|
99
|
+
// BAD: Restates the code
|
|
100
|
+
// Increment counter by 1
|
|
101
|
+
counter += 1;
|
|
102
|
+
|
|
103
|
+
// GOOD: Explains non-obvious intent
|
|
104
|
+
// Rate limit uses a sliding window — reset counter at window boundary,
|
|
105
|
+
// not on a fixed schedule, to prevent burst attacks at window edges
|
|
106
|
+
if (now - windowStart > WINDOW_SIZE_MS) {
|
|
107
|
+
counter = 0;
|
|
108
|
+
windowStart = now;
|
|
109
|
+
}
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
### When NOT to Comment
|
|
113
|
+
|
|
114
|
+
```typescript
|
|
115
|
+
// Don't comment self-explanatory code
|
|
116
|
+
function calculateTotal(items: CartItem[]): number {
|
|
117
|
+
return items.reduce((sum, item) => sum + item.price * item.quantity, 0);
|
|
118
|
+
}
|
|
119
|
+
|
|
120
|
+
// Don't leave TODO comments for things you should just do now
|
|
121
|
+
// TODO: add error handling ← Just add it
|
|
122
|
+
|
|
123
|
+
// Don't leave commented-out code
|
|
124
|
+
// const oldImplementation = () => { ... } ← Delete it, git has history
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
### Document Known Gotchas
|
|
128
|
+
|
|
129
|
+
```typescript
|
|
130
|
+
/**
|
|
131
|
+
* IMPORTANT: This function must be called before the first render.
|
|
132
|
+
* If called after hydration, it causes a flash of unstyled content
|
|
133
|
+
* because the theme context isn't available during SSR.
|
|
134
|
+
*
|
|
135
|
+
* See ADR-003 for the full design rationale.
|
|
136
|
+
*/
|
|
137
|
+
export function initializeTheme(theme: Theme): void {
|
|
138
|
+
// ...
|
|
139
|
+
}
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
## API Documentation
|
|
143
|
+
|
|
144
|
+
For public APIs (REST, GraphQL, library interfaces):
|
|
145
|
+
|
|
146
|
+
### Inline with Types (Preferred for TypeScript)
|
|
147
|
+
|
|
148
|
+
```typescript
|
|
149
|
+
/**
|
|
150
|
+
* Creates a new task.
|
|
151
|
+
*
|
|
152
|
+
* @param input - Task creation data (title required, description optional)
|
|
153
|
+
* @returns The created task with server-generated ID and timestamps
|
|
154
|
+
* @throws {ValidationError} If title is empty or exceeds 200 characters
|
|
155
|
+
* @throws {AuthenticationError} If the user is not authenticated
|
|
156
|
+
*
|
|
157
|
+
* @example
|
|
158
|
+
* const task = await createTask({ title: 'Buy groceries' });
|
|
159
|
+
* console.log(task.id); // "task_abc123"
|
|
160
|
+
*/
|
|
161
|
+
export async function createTask(input: CreateTaskInput): Promise<Task> {
|
|
162
|
+
// ...
|
|
163
|
+
}
|
|
164
|
+
```
|
|
165
|
+
|
|
166
|
+
### OpenAPI / Swagger for REST APIs
|
|
167
|
+
|
|
168
|
+
```yaml
|
|
169
|
+
paths:
|
|
170
|
+
/api/tasks:
|
|
171
|
+
post:
|
|
172
|
+
summary: Create a task
|
|
173
|
+
requestBody:
|
|
174
|
+
required: true
|
|
175
|
+
content:
|
|
176
|
+
application/json:
|
|
177
|
+
schema:
|
|
178
|
+
$ref: '#/components/schemas/CreateTaskInput'
|
|
179
|
+
responses:
|
|
180
|
+
'201':
|
|
181
|
+
description: Task created
|
|
182
|
+
content:
|
|
183
|
+
application/json:
|
|
184
|
+
schema:
|
|
185
|
+
$ref: '#/components/schemas/Task'
|
|
186
|
+
'422':
|
|
187
|
+
description: Validation error
|
|
188
|
+
```
|
|
189
|
+
|
|
190
|
+
## README Structure
|
|
191
|
+
|
|
192
|
+
Every project should have a README that covers:
|
|
193
|
+
|
|
194
|
+
```markdown
|
|
195
|
+
# Project Name
|
|
196
|
+
|
|
197
|
+
One-paragraph description of what this project does.
|
|
198
|
+
|
|
199
|
+
## Quick Start
|
|
200
|
+
1. Clone the repo
|
|
201
|
+
2. Install dependencies: `npm install`
|
|
202
|
+
3. Set up environment: `cp .env.example .env`
|
|
203
|
+
4. Run the dev server: `npm run dev`
|
|
204
|
+
|
|
205
|
+
## Commands
|
|
206
|
+
| Command | Description |
|
|
207
|
+
|---------|-------------|
|
|
208
|
+
| `npm run dev` | Start development server |
|
|
209
|
+
| `npm test` | Run tests |
|
|
210
|
+
| `npm run build` | Production build |
|
|
211
|
+
| `npm run lint` | Run linter |
|
|
212
|
+
|
|
213
|
+
## Architecture
|
|
214
|
+
Brief overview of the project structure and key design decisions.
|
|
215
|
+
Link to ADRs for details.
|
|
216
|
+
|
|
217
|
+
## Contributing
|
|
218
|
+
How to contribute, coding standards, PR process.
|
|
219
|
+
```
|
|
220
|
+
|
|
221
|
+
## Changelog Maintenance
|
|
222
|
+
|
|
223
|
+
For shipped features:
|
|
224
|
+
|
|
225
|
+
```markdown
|
|
226
|
+
# Changelog
|
|
227
|
+
|
|
228
|
+
## [1.2.0] - 2025-01-20
|
|
229
|
+
### Added
|
|
230
|
+
- Task sharing: users can share tasks with team members (#123)
|
|
231
|
+
- Email notifications for task assignments (#124)
|
|
232
|
+
|
|
233
|
+
### Fixed
|
|
234
|
+
- Duplicate tasks appearing when rapidly clicking create button (#125)
|
|
235
|
+
|
|
236
|
+
### Changed
|
|
237
|
+
- Task list now loads 50 items per page (was 20) for better UX (#126)
|
|
238
|
+
```
|
|
239
|
+
|
|
240
|
+
## Documentation for Agents
|
|
241
|
+
|
|
242
|
+
Special consideration for AI agent context:
|
|
243
|
+
|
|
244
|
+
- **CLAUDE.md / rules files** — Document project conventions so agents follow them
|
|
245
|
+
- **Spec files** — Keep specs updated so agents build the right thing
|
|
246
|
+
- **ADRs** — Help agents understand why past decisions were made (prevents re-deciding)
|
|
247
|
+
- **Inline gotchas** — Prevent agents from falling into known traps
|
|
248
|
+
|
|
249
|
+
## Common Rationalizations
|
|
250
|
+
|
|
251
|
+
| Rationalization | Reality |
|
|
252
|
+
|---|---|
|
|
253
|
+
| "The code is self-documenting" | Code shows what. It doesn't show why, what alternatives were rejected, or what constraints apply. |
|
|
254
|
+
| "We'll write docs when the API stabilizes" | APIs stabilize faster when you document them. The doc is the first test of the design. |
|
|
255
|
+
| "Nobody reads docs" | Agents do. Future engineers do. Your 3-months-later self does. |
|
|
256
|
+
| "ADRs are overhead" | A 10-minute ADR prevents a 2-hour debate about the same decision six months later. |
|
|
257
|
+
| "Comments get outdated" | Comments on *why* are stable. Comments on *what* get outdated — that's why you only write the former. |
|
|
258
|
+
|
|
259
|
+
## Red Flags
|
|
260
|
+
|
|
261
|
+
- Architectural decisions with no written rationale
|
|
262
|
+
- Public APIs with no documentation or types
|
|
263
|
+
- README that doesn't explain how to run the project
|
|
264
|
+
- Commented-out code instead of deletion
|
|
265
|
+
- TODO comments that have been there for weeks
|
|
266
|
+
- No ADRs in a project with significant architectural choices
|
|
267
|
+
- Documentation that restates the code instead of explaining intent
|
|
268
|
+
|
|
269
|
+
## Verification
|
|
270
|
+
|
|
271
|
+
After documenting:
|
|
272
|
+
|
|
273
|
+
- [ ] ADRs exist for all significant architectural decisions
|
|
274
|
+
- [ ] README covers quick start, commands, and architecture overview
|
|
275
|
+
- [ ] API functions have parameter and return type documentation
|
|
276
|
+
- [ ] Known gotchas are documented inline where they matter
|
|
277
|
+
- [ ] No commented-out code remains
|
|
278
|
+
- [ ] Rules files (CLAUDE.md etc.) are current and accurate
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
# ADR Format
|
|
2
|
+
|
|
3
|
+
ADRs live in `docs/adr/` and use sequential numbering: `0001-slug.md`, `0002-slug.md`, and so on.
|
|
4
|
+
|
|
5
|
+
Create the `docs/adr/` directory lazily, only when the first ADR is needed.
|
|
6
|
+
|
|
7
|
+
## Template
|
|
8
|
+
|
|
9
|
+
```md
|
|
10
|
+
# {Short title of the decision}
|
|
11
|
+
|
|
12
|
+
{1-3 sentences: what is the context, what did we decide, and why.}
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
That is enough for many ADRs. The value is in recording that a decision was made and why, not in filling out sections.
|
|
16
|
+
|
|
17
|
+
## Optional Sections
|
|
18
|
+
|
|
19
|
+
Only include these when they add genuine value:
|
|
20
|
+
|
|
21
|
+
- Status frontmatter: `proposed`, `accepted`, `deprecated`, or `superseded by ADR-NNNN`
|
|
22
|
+
- Considered Options: only when the rejected alternatives are worth remembering
|
|
23
|
+
- Consequences: only when non-obvious downstream effects need to be called out
|
|
24
|
+
|
|
25
|
+
## Numbering
|
|
26
|
+
|
|
27
|
+
Scan `docs/adr/` for the highest existing number and increment by one.
|
|
28
|
+
|
|
29
|
+
## When To Offer An ADR
|
|
30
|
+
|
|
31
|
+
All three of these must be true:
|
|
32
|
+
|
|
33
|
+
1. Hard to reverse: the cost of changing your mind later is meaningful.
|
|
34
|
+
2. Surprising without context: a future reader will wonder why the decision was made.
|
|
35
|
+
3. Based on a real trade-off: there were genuine alternatives and one was chosen for specific reasons.
|
|
36
|
+
|
|
37
|
+
If a decision is easy to reverse, skip it. If it is not surprising, nobody will need the explanation. If there was no real alternative, there is nothing to record beyond doing the obvious thing.
|
|
38
|
+
|
|
39
|
+
## What Qualifies
|
|
40
|
+
|
|
41
|
+
- Architectural shape, such as monorepo structure or event-sourced write models.
|
|
42
|
+
- Integration patterns between contexts.
|
|
43
|
+
- Technology choices that carry lock-in, such as database, message bus, auth provider, or deployment target.
|
|
44
|
+
- Boundary and scope decisions.
|
|
45
|
+
- Deliberate deviations from the obvious path.
|
|
46
|
+
- Constraints not visible in the code.
|
|
47
|
+
- Rejected alternatives when the rejection is non-obvious.
|