@hivehub/rulebook 5.4.1 → 5.5.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.claude/commands/analysis.md +35 -35
- package/.claude/commands/continue.md +33 -33
- package/.claude/commands/ralph-config.md +112 -112
- package/.claude/commands/ralph-history.md +110 -110
- package/.claude/commands/ralph-init.md +72 -72
- package/.claude/commands/ralph-pause-resume.md +105 -105
- package/.claude/commands/ralph-run.md +101 -101
- package/.claude/commands/ralph-status.md +76 -76
- package/.claude/commands/rulebook-decision-create.md +55 -55
- package/.claude/commands/rulebook-decision-list.md +15 -15
- package/.claude/commands/rulebook-knowledge-add.md +41 -41
- package/.claude/commands/rulebook-knowledge-list.md +15 -15
- package/.claude/commands/rulebook-learn-capture.md +48 -48
- package/.claude/commands/rulebook-learn-list.md +13 -13
- package/.claude/commands/rulebook-memory-save.md +48 -48
- package/.claude/commands/rulebook-memory-search.md +47 -47
- package/.claude/commands/rulebook-task-apply.md +67 -67
- package/.claude/commands/rulebook-task-archive.md +94 -94
- package/.claude/commands/rulebook-task-create.md +93 -93
- package/.claude/commands/rulebook-task-list.md +42 -42
- package/.claude/commands/rulebook-task-show.md +52 -52
- package/.claude/commands/rulebook-task-validate.md +53 -53
- package/.claude-plugin/marketplace.json +28 -28
- package/.claude-plugin/plugin.json +8 -8
- package/README.md +394 -393
- package/dist/core/generator.d.ts +1 -1
- package/dist/core/generator.d.ts.map +1 -1
- package/dist/core/generator.js +1 -0
- package/dist/core/generator.js.map +1 -1
- package/dist/hooks/terse-activate.d.ts +59 -0
- package/dist/hooks/terse-activate.d.ts.map +1 -0
- package/dist/hooks/terse-activate.js +149 -0
- package/dist/hooks/terse-activate.js.map +1 -0
- package/dist/hooks/terse-config.d.ts +51 -0
- package/dist/hooks/terse-config.d.ts.map +1 -0
- package/dist/hooks/terse-config.js +130 -0
- package/dist/hooks/terse-config.js.map +1 -0
- package/dist/hooks/terse-mode-tracker.d.ts +78 -0
- package/dist/hooks/terse-mode-tracker.d.ts.map +1 -0
- package/dist/hooks/terse-mode-tracker.js +213 -0
- package/dist/hooks/terse-mode-tracker.js.map +1 -0
- package/dist/index.js +0 -0
- package/dist/mcp/rulebook-server.js +0 -0
- package/package.json +21 -22
- package/templates/agents/accessibility-reviewer.md +43 -43
- package/templates/agents/api-designer.md +42 -42
- package/templates/agents/architect.md +51 -51
- package/templates/agents/build-engineer.md +36 -36
- package/templates/agents/code-reviewer.md +47 -47
- package/templates/agents/compiler/codegen-debugger.md +34 -34
- package/templates/agents/compiler/stdlib-engineer.md +28 -28
- package/templates/agents/compiler/test-coverage-guardian.md +31 -31
- package/templates/agents/context-intelligence.md +52 -52
- package/templates/agents/database-architect.md +41 -41
- package/templates/agents/devops-engineer.md +42 -42
- package/templates/agents/docs-writer.md +38 -38
- package/templates/agents/game-engine/cpp-core-expert.md +35 -35
- package/templates/agents/game-engine/render-engineer.md +22 -22
- package/templates/agents/game-engine/shader-engineer.md +38 -38
- package/templates/agents/game-engine/systems-integration.md +43 -43
- package/templates/agents/generic/code-reviewer.md +41 -41
- package/templates/agents/generic/docs-writer.md +25 -25
- package/templates/agents/generic/project-manager.md +36 -36
- package/templates/agents/generic/researcher.md +34 -34
- package/templates/agents/generic/test-engineer.md +41 -41
- package/templates/agents/i18n-engineer.md +42 -42
- package/templates/agents/implementer.md +42 -42
- package/templates/agents/migration-engineer.md +42 -42
- package/templates/agents/mobile/platform-specialist.md +22 -22
- package/templates/agents/mobile/ui-engineer.md +22 -22
- package/templates/agents/performance-engineer.md +49 -49
- package/templates/agents/refactoring-agent.md +41 -41
- package/templates/agents/researcher.md +38 -38
- package/templates/agents/security-reviewer.md +40 -40
- package/templates/agents/team-lead.md +37 -37
- package/templates/agents/tester.md +48 -48
- package/templates/agents/ux-reviewer.md +43 -43
- package/templates/agents/web-app/api-designer.md +22 -22
- package/templates/agents/web-app/backend-engineer.md +30 -30
- package/templates/agents/web-app/database-engineer.md +22 -22
- package/templates/agents/web-app/frontend-engineer.md +29 -29
- package/templates/agents/web-app/security-reviewer.md +32 -32
- package/templates/ci/rulebook-review.yml +26 -26
- package/templates/cli/AIDER.md +49 -49
- package/templates/cli/AMAZON_Q.md +25 -25
- package/templates/cli/AUGGIE.md +32 -32
- package/templates/cli/CLAUDE.md +117 -117
- package/templates/cli/CLINE.md +99 -99
- package/templates/cli/CODEBUDDY.md +20 -20
- package/templates/cli/CODEIUM.md +20 -20
- package/templates/cli/CODEX.md +21 -21
- package/templates/cli/CONTINUE.md +34 -34
- package/templates/cli/CURSOR_CLI.md +62 -62
- package/templates/cli/FACTORY.md +18 -18
- package/templates/cli/GEMINI.md +35 -35
- package/templates/cli/KILOCODE.md +18 -18
- package/templates/cli/OPENCODE.md +18 -18
- package/templates/cli/_GENERIC_TEMPLATE.md +29 -29
- package/templates/commands/rulebook-decision-create.md +55 -55
- package/templates/commands/rulebook-decision-list.md +15 -15
- package/templates/commands/rulebook-knowledge-add.md +41 -41
- package/templates/commands/rulebook-knowledge-list.md +15 -15
- package/templates/commands/rulebook-learn-capture.md +48 -48
- package/templates/commands/rulebook-learn-list.md +13 -13
- package/templates/commands/rulebook-memory-save.md +48 -48
- package/templates/commands/rulebook-memory-search.md +47 -47
- package/templates/commands/rulebook-task-apply.md +67 -67
- package/templates/commands/rulebook-task-archive.md +94 -94
- package/templates/commands/rulebook-task-create.md +93 -93
- package/templates/commands/rulebook-task-list.md +42 -42
- package/templates/commands/rulebook-task-show.md +52 -52
- package/templates/commands/rulebook-task-validate.md +53 -53
- package/templates/compact-context/_default.md +23 -23
- package/templates/compact-context/cpp.md +26 -26
- package/templates/compact-context/go.md +26 -26
- package/templates/compact-context/python.md +26 -26
- package/templates/compact-context/rust.md +28 -28
- package/templates/compact-context/typescript.md +29 -29
- package/templates/core/AGENTS_LEAN.md +26 -1
- package/templates/core/AGENTS_OVERRIDE.md +16 -16
- package/templates/core/AGENT_AUTOMATION.md +296 -296
- package/templates/core/CLAUDE_MD_v2.md +90 -71
- package/templates/core/DAG.md +304 -304
- package/templates/core/DECISIONS.md +38 -38
- package/templates/core/DOCUMENTATION_RULES.md +36 -36
- package/templates/core/KNOWLEDGE.md +49 -49
- package/templates/core/MULTI_AGENT.md +74 -74
- package/templates/core/PLANS.md +28 -28
- package/templates/core/QUALITY_ENFORCEMENT.md +68 -68
- package/templates/core/RALPH.md +471 -471
- package/templates/core/RULEBOOK.md +1947 -1947
- package/templates/core/TIER1_PROHIBITIONS.md +154 -154
- package/templates/core/TOKEN_OPTIMIZATION.md +49 -49
- package/templates/frameworks/ANGULAR.md +36 -36
- package/templates/frameworks/DJANGO.md +83 -83
- package/templates/frameworks/ELECTRON.md +147 -147
- package/templates/frameworks/FLASK.md +38 -38
- package/templates/frameworks/FLUTTER.md +55 -55
- package/templates/frameworks/JQUERY.md +32 -32
- package/templates/frameworks/LARAVEL.md +38 -38
- package/templates/frameworks/NESTJS.md +43 -43
- package/templates/frameworks/NEXTJS.md +127 -127
- package/templates/frameworks/NUXT.md +40 -40
- package/templates/frameworks/RAILS.md +66 -66
- package/templates/frameworks/REACT.md +38 -38
- package/templates/frameworks/REACT_NATIVE.md +47 -47
- package/templates/frameworks/SPRING.md +39 -39
- package/templates/frameworks/SYMFONY.md +36 -36
- package/templates/frameworks/VUE.md +36 -36
- package/templates/frameworks/ZEND.md +35 -35
- package/templates/git/CI_CD_PATTERNS.md +661 -661
- package/templates/git/GITHUB_ACTIONS.md +728 -728
- package/templates/git/GITLAB_CI.md +730 -730
- package/templates/git/GIT_WORKFLOW.md +1192 -1192
- package/templates/git/SECRETS_MANAGEMENT.md +585 -585
- package/templates/hooks/COMMIT_MSG.md +530 -530
- package/templates/hooks/POST_CHECKOUT.md +546 -546
- package/templates/hooks/PREPARE_COMMIT_MSG.md +619 -619
- package/templates/hooks/PRE_COMMIT.md +414 -414
- package/templates/hooks/PRE_PUSH.md +601 -601
- package/templates/hooks/check-context-and-handoff.ps1 +58 -58
- package/templates/hooks/check-context-and-handoff.sh +76 -76
- package/templates/hooks/enforce-team-for-background-agents.ps1 +63 -63
- package/templates/hooks/enforce-team-for-background-agents.sh +55 -55
- package/templates/hooks/on-compact-reinject.sh +34 -34
- package/templates/hooks/resume-from-handoff.ps1 +40 -40
- package/templates/hooks/resume-from-handoff.sh +61 -61
- package/templates/hooks/terse-activate.ps1 +143 -143
- package/templates/hooks/terse-activate.sh +197 -197
- package/templates/hooks/terse-mode-tracker.ps1 +153 -153
- package/templates/hooks/terse-mode-tracker.sh +187 -187
- package/templates/ides/CONTINUE_RULES.md +16 -16
- package/templates/ides/COPILOT.md +37 -37
- package/templates/ides/COPILOT_INSTRUCTIONS.md +23 -23
- package/templates/ides/CURSOR.md +43 -43
- package/templates/ides/GEMINI_RULES.md +17 -17
- package/templates/ides/JETBRAINS_AI.md +35 -35
- package/templates/ides/REPLIT.md +36 -36
- package/templates/ides/TABNINE.md +29 -29
- package/templates/ides/VSCODE.md +40 -40
- package/templates/ides/WINDSURF.md +36 -36
- package/templates/ides/WINDSURF_RULES.md +14 -14
- package/templates/ides/ZED.md +32 -32
- package/templates/ides/cursor-mdc/go.mdc +24 -24
- package/templates/ides/cursor-mdc/python.mdc +24 -24
- package/templates/ides/cursor-mdc/quality.mdc +25 -25
- package/templates/ides/cursor-mdc/ralph.mdc +39 -39
- package/templates/ides/cursor-mdc/rulebook.mdc +38 -38
- package/templates/ides/cursor-mdc/rust.mdc +24 -24
- package/templates/ides/cursor-mdc/typescript.mdc +25 -25
- package/templates/languages/C.md +333 -333
- package/templates/languages/CPP.md +743 -743
- package/templates/languages/CSHARP.md +417 -417
- package/templates/languages/ELIXIR.md +454 -454
- package/templates/languages/ERLANG.md +361 -361
- package/templates/languages/GO.md +645 -645
- package/templates/languages/HASKELL.md +177 -177
- package/templates/languages/JAVA.md +607 -607
- package/templates/languages/JAVASCRIPT.md +631 -631
- package/templates/languages/JULIA.md +97 -97
- package/templates/languages/KOTLIN.md +511 -511
- package/templates/languages/LISP.md +100 -100
- package/templates/languages/LUA.md +74 -74
- package/templates/languages/OBJECTIVEC.md +90 -90
- package/templates/languages/PHP.md +416 -416
- package/templates/languages/PYTHON.md +682 -682
- package/templates/languages/RUBY.md +421 -421
- package/templates/languages/RUST.md +477 -477
- package/templates/languages/SAS.md +73 -73
- package/templates/languages/SCALA.md +348 -348
- package/templates/languages/SOLIDITY.md +580 -580
- package/templates/languages/SQL.md +137 -137
- package/templates/languages/SWIFT.md +466 -466
- package/templates/languages/TYPESCRIPT.md +591 -591
- package/templates/languages/ZIG.md +265 -265
- package/templates/modules/ATLASSIAN.md +255 -255
- package/templates/modules/CONTEXT7.md +54 -54
- package/templates/modules/FIGMA.md +267 -267
- package/templates/modules/GITHUB_MCP.md +64 -64
- package/templates/modules/GRAFANA.md +328 -328
- package/templates/modules/MEMORY.md +126 -126
- package/templates/modules/NOTION.md +247 -247
- package/templates/modules/PLAYWRIGHT.md +90 -90
- package/templates/modules/RULEBOOK_MCP.md +208 -208
- package/templates/modules/SERENA.md +337 -337
- package/templates/modules/SUPABASE.md +223 -223
- package/templates/modules/SYNAP.md +69 -69
- package/templates/modules/VECTORIZER.md +63 -63
- package/templates/modules/sequential-thinking.md +42 -42
- package/templates/ralph/ralph-history.bat +4 -4
- package/templates/ralph/ralph-history.sh +5 -5
- package/templates/ralph/ralph-init.bat +5 -5
- package/templates/ralph/ralph-init.sh +5 -5
- package/templates/ralph/ralph-pause.bat +5 -5
- package/templates/ralph/ralph-pause.sh +5 -5
- package/templates/ralph/ralph-run.bat +5 -5
- package/templates/ralph/ralph-run.sh +5 -5
- package/templates/ralph/ralph-status.bat +4 -4
- package/templates/ralph/ralph-status.sh +5 -5
- package/templates/rules/consult-analysis-before-implementing.md +23 -23
- package/templates/rules/cpp.md +46 -46
- package/templates/rules/csharp.md +44 -44
- package/templates/rules/diagnostic-first.md +39 -39
- package/templates/rules/fail-twice-escalate.md +46 -46
- package/templates/rules/follow-task-sequence.md +36 -36
- package/templates/rules/git-safety.md +29 -29
- package/templates/rules/go.md +40 -40
- package/templates/rules/incremental-implementation.md +56 -56
- package/templates/rules/incremental-tests.md +29 -29
- package/templates/rules/java.md +43 -43
- package/templates/rules/javascript.md +39 -39
- package/templates/rules/knowledge-base-usage.md +41 -41
- package/templates/rules/multi-agent-teams.md +75 -75
- package/templates/rules/no-deferred.md +31 -31
- package/templates/rules/no-shortcuts.md +30 -30
- package/templates/rules/python.md +43 -43
- package/templates/rules/research-first.md +30 -30
- package/templates/rules/respect-handoff-trigger.md +41 -41
- package/templates/rules/rust.md +40 -40
- package/templates/rules/sequential-editing.md +21 -21
- package/templates/rules/session-workflow.md +24 -24
- package/templates/rules/task-decomposition.md +32 -32
- package/templates/rules/typescript.md +40 -40
- package/templates/services/AZURE_BLOB.md +184 -184
- package/templates/services/CASSANDRA.md +239 -239
- package/templates/services/DATADOG.md +26 -26
- package/templates/services/DOCKER.md +124 -124
- package/templates/services/DOCKER_COMPOSE.md +168 -168
- package/templates/services/DYNAMODB.md +308 -308
- package/templates/services/ELASTICSEARCH.md +347 -347
- package/templates/services/GCS.md +178 -178
- package/templates/services/HELM.md +194 -194
- package/templates/services/INFLUXDB.md +265 -265
- package/templates/services/KAFKA.md +341 -341
- package/templates/services/KUBERNETES.md +208 -208
- package/templates/services/MARIADB.md +183 -183
- package/templates/services/MEMCACHED.md +242 -242
- package/templates/services/MINIO.md +201 -201
- package/templates/services/MONGODB.md +268 -268
- package/templates/services/MYSQL.md +358 -358
- package/templates/services/NEO4J.md +247 -247
- package/templates/services/OPENTELEMETRY.md +25 -25
- package/templates/services/ORACLE.md +290 -290
- package/templates/services/PINO.md +24 -24
- package/templates/services/POSTGRESQL.md +326 -326
- package/templates/services/PROMETHEUS.md +33 -33
- package/templates/services/RABBITMQ.md +286 -286
- package/templates/services/REDIS.md +292 -292
- package/templates/services/S3.md +298 -298
- package/templates/services/SENTRY.md +23 -23
- package/templates/services/SQLITE.md +294 -294
- package/templates/services/SQLSERVER.md +294 -294
- package/templates/services/WINSTON.md +30 -30
- package/templates/skills/cli/aider/SKILL.md +59 -59
- package/templates/skills/cli/amazon-q/SKILL.md +35 -35
- package/templates/skills/cli/auggie/SKILL.md +42 -42
- package/templates/skills/cli/claude/SKILL.md +42 -42
- package/templates/skills/cli/cline/SKILL.md +42 -42
- package/templates/skills/cli/codebuddy/SKILL.md +30 -30
- package/templates/skills/cli/codeium/SKILL.md +30 -30
- package/templates/skills/cli/codex/SKILL.md +31 -31
- package/templates/skills/cli/continue/SKILL.md +44 -44
- package/templates/skills/cli/cursor-cli/SKILL.md +38 -38
- package/templates/skills/cli/factory/SKILL.md +28 -28
- package/templates/skills/cli/gemini/SKILL.md +45 -45
- package/templates/skills/cli/kilocode/SKILL.md +28 -28
- package/templates/skills/cli/opencode/SKILL.md +28 -28
- package/templates/skills/core/agent-automation/SKILL.md +194 -194
- package/templates/skills/core/dag/SKILL.md +314 -314
- package/templates/skills/core/documentation-rules/SKILL.md +46 -46
- package/templates/skills/core/karpathy-guidelines/SKILL.md +93 -0
- package/templates/skills/core/quality-enforcement/SKILL.md +78 -78
- package/templates/skills/core/rulebook/SKILL.md +176 -176
- package/templates/skills/core/rulebook-terse/SKILL.md +116 -116
- package/templates/skills/core/rulebook-terse-commit/SKILL.md +96 -96
- package/templates/skills/core/rulebook-terse-review/SKILL.md +112 -112
- package/templates/skills/dev/accessibility/SKILL.md +17 -17
- package/templates/skills/dev/analysis/SKILL.md +19 -19
- package/templates/skills/dev/api-design/SKILL.md +15 -15
- package/templates/skills/dev/architect/SKILL.md +17 -17
- package/templates/skills/dev/build-fix/SKILL.md +17 -17
- package/templates/skills/dev/db-design/SKILL.md +15 -15
- package/templates/skills/dev/debug/SKILL.md +16 -16
- package/templates/skills/dev/deploy/SKILL.md +17 -17
- package/templates/skills/dev/docs/SKILL.md +17 -17
- package/templates/skills/dev/handoff/SKILL.md +27 -27
- package/templates/skills/dev/migrate/SKILL.md +15 -15
- package/templates/skills/dev/perf/SKILL.md +17 -17
- package/templates/skills/dev/refactor/SKILL.md +17 -17
- package/templates/skills/dev/research/SKILL.md +14 -14
- package/templates/skills/dev/review/SKILL.md +18 -18
- package/templates/skills/dev/security-audit/SKILL.md +17 -17
- package/templates/skills/frameworks/angular/SKILL.md +46 -46
- package/templates/skills/frameworks/django/SKILL.md +93 -93
- package/templates/skills/frameworks/electron/SKILL.md +157 -157
- package/templates/skills/frameworks/flask/SKILL.md +48 -48
- package/templates/skills/frameworks/flutter/SKILL.md +65 -65
- package/templates/skills/frameworks/jquery/SKILL.md +42 -42
- package/templates/skills/frameworks/laravel/SKILL.md +48 -48
- package/templates/skills/frameworks/nestjs/SKILL.md +53 -53
- package/templates/skills/frameworks/nextjs/SKILL.md +137 -137
- package/templates/skills/frameworks/nuxt/SKILL.md +50 -50
- package/templates/skills/frameworks/rails/SKILL.md +76 -76
- package/templates/skills/frameworks/react/SKILL.md +48 -48
- package/templates/skills/frameworks/react-native/SKILL.md +57 -57
- package/templates/skills/frameworks/spring/SKILL.md +49 -49
- package/templates/skills/frameworks/symfony/SKILL.md +46 -46
- package/templates/skills/frameworks/vue/SKILL.md +46 -46
- package/templates/skills/frameworks/zend/SKILL.md +45 -45
- package/templates/skills/ides/copilot/SKILL.md +47 -47
- package/templates/skills/ides/cursor/SKILL.md +53 -53
- package/templates/skills/ides/jetbrains-ai/SKILL.md +45 -45
- package/templates/skills/ides/replit/SKILL.md +46 -46
- package/templates/skills/ides/tabnine/SKILL.md +39 -39
- package/templates/skills/ides/vscode/SKILL.md +50 -50
- package/templates/skills/ides/windsurf/SKILL.md +46 -46
- package/templates/skills/ides/zed/SKILL.md +42 -42
- package/templates/skills/languages/c/SKILL.md +343 -343
- package/templates/skills/languages/cpp/SKILL.md +753 -753
- package/templates/skills/languages/csharp/SKILL.md +427 -427
- package/templates/skills/languages/elixir/SKILL.md +464 -464
- package/templates/skills/languages/erlang/SKILL.md +371 -371
- package/templates/skills/languages/go/SKILL.md +655 -655
- package/templates/skills/languages/haskell/SKILL.md +187 -187
- package/templates/skills/languages/java/SKILL.md +617 -617
- package/templates/skills/languages/javascript/SKILL.md +641 -641
- package/templates/skills/languages/julia/SKILL.md +107 -107
- package/templates/skills/languages/kotlin/SKILL.md +521 -521
- package/templates/skills/languages/lisp/SKILL.md +110 -110
- package/templates/skills/languages/lua/SKILL.md +84 -84
- package/templates/skills/languages/objectivec/SKILL.md +100 -100
- package/templates/skills/languages/php/SKILL.md +426 -426
- package/templates/skills/languages/python/SKILL.md +692 -692
- package/templates/skills/languages/ruby/SKILL.md +431 -431
- package/templates/skills/languages/rust/SKILL.md +487 -487
- package/templates/skills/languages/sas/SKILL.md +83 -83
- package/templates/skills/languages/scala/SKILL.md +358 -358
- package/templates/skills/languages/solidity/SKILL.md +590 -590
- package/templates/skills/languages/sql/SKILL.md +147 -147
- package/templates/skills/languages/swift/SKILL.md +476 -476
- package/templates/skills/languages/typescript/SKILL.md +302 -302
- package/templates/skills/languages/zig/SKILL.md +275 -275
- package/templates/skills/modules/atlassian/SKILL.md +265 -265
- package/templates/skills/modules/context7/SKILL.md +64 -64
- package/templates/skills/modules/figma/SKILL.md +277 -277
- package/templates/skills/modules/github-mcp/SKILL.md +74 -74
- package/templates/skills/modules/grafana/SKILL.md +338 -338
- package/templates/skills/modules/memory/SKILL.md +73 -73
- package/templates/skills/modules/notion/SKILL.md +257 -257
- package/templates/skills/modules/playwright/SKILL.md +100 -100
- package/templates/skills/modules/rulebook-mcp/SKILL.md +166 -166
- package/templates/skills/modules/serena/SKILL.md +347 -347
- package/templates/skills/modules/supabase/SKILL.md +233 -233
- package/templates/skills/modules/synap/SKILL.md +79 -79
- package/templates/skills/modules/vectorizer/SKILL.md +73 -73
- package/templates/skills/services/azure-blob/SKILL.md +194 -194
- package/templates/skills/services/cassandra/SKILL.md +249 -249
- package/templates/skills/services/dynamodb/SKILL.md +318 -318
- package/templates/skills/services/elasticsearch/SKILL.md +357 -357
- package/templates/skills/services/gcs/SKILL.md +188 -188
- package/templates/skills/services/influxdb/SKILL.md +275 -275
- package/templates/skills/services/kafka/SKILL.md +351 -351
- package/templates/skills/services/mariadb/SKILL.md +193 -193
- package/templates/skills/services/memcached/SKILL.md +252 -252
- package/templates/skills/services/minio/SKILL.md +211 -211
- package/templates/skills/services/mongodb/SKILL.md +278 -278
- package/templates/skills/services/mysql/SKILL.md +368 -368
- package/templates/skills/services/neo4j/SKILL.md +257 -257
- package/templates/skills/services/oracle/SKILL.md +300 -300
- package/templates/skills/services/postgresql/SKILL.md +336 -336
- package/templates/skills/services/rabbitmq/SKILL.md +296 -296
- package/templates/skills/services/redis/SKILL.md +302 -302
- package/templates/skills/services/s3/SKILL.md +308 -308
- package/templates/skills/services/sqlite/SKILL.md +304 -304
- package/templates/skills/services/sqlserver/SKILL.md +304 -304
- package/templates/skills/workflows/ralph/SKILL.md +309 -309
- package/templates/skills/workflows/ralph/install.sh +87 -87
- package/templates/skills/workflows/ralph/manifest.json +158 -158
|
@@ -16,6 +16,15 @@ These override everything else. Violation = output rejected.
|
|
|
16
16
|
7. **Follow task sequence.** Execute `tasks.md` items in the EXACT order listed. No reordering, no cherry-picking, no starting Phase N+1 before Phase N is 100% done. The list is an ORDER, not a MENU.
|
|
17
17
|
8. **Execute the full task in one turn.** Never stop mid-task to ask "should I proceed?" or "want me to also...?". Make autonomous decisions within scope. Only ask for genuine ambiguity, destructive ops, or impossible tasks.
|
|
18
18
|
|
|
19
|
+
## Editing Discipline (Karpathy-inspired)
|
|
20
|
+
|
|
21
|
+
Behavioral guidelines that reduce common LLM coding mistakes. Adapted from [forrestchang/andrej-karpathy-skills](https://github.com/forrestchang/andrej-karpathy-skills), grounded in [Andrej Karpathy's observations](https://x.com/karpathy/status/2015883857489522876).
|
|
22
|
+
|
|
23
|
+
1. **Think before coding.** State assumptions explicitly. If multiple interpretations exist, present them — don't pick silently. If a simpler approach exists, say so. If something is unclear, stop and ask. Don't hide confusion.
|
|
24
|
+
2. **Simplicity first.** Minimum code that solves the problem. No features beyond what was asked, no abstractions for single-use code, no "flexibility" that wasn't requested, no error handling for impossible scenarios. If you write 200 lines and 50 would do, rewrite.
|
|
25
|
+
3. **Surgical changes.** Touch only what you must. Don't "improve" adjacent code, comments, or formatting. Don't refactor things that aren't broken. Match existing style. If you notice unrelated dead code, mention it — don't delete it. Every changed line must trace directly to the user's request.
|
|
26
|
+
4. **Goal-driven execution.** Define verifiable success criteria upfront. "Add validation" → "write tests for invalid inputs, then make them pass." For multi-step tasks, state a brief plan: `[step] → verify: [check]`. Strong criteria let you loop independently; weak criteria require constant clarification.
|
|
27
|
+
|
|
19
28
|
## Critical Rules
|
|
20
29
|
|
|
21
30
|
- **ALWAYS read `/.rulebook/specs/RULEBOOK.md`** before creating tasks.
|
|
@@ -185,7 +194,23 @@ If this is part of a multi-project workspace, every Rulebook MCP call MUST pass
|
|
|
185
194
|
| Build/CI | build-engineer | sonnet |
|
|
186
195
|
| Security | security-reviewer | haiku |
|
|
187
196
|
|
|
188
|
-
|
|
197
|
+
### Mandatory delegation rules
|
|
198
|
+
|
|
199
|
+
- **Never implement directly in the main conversation when an agent fits.** The main thread orchestrates; agents do the work.
|
|
200
|
+
- **Read-only work → haiku researcher.** Cheap, isolates context.
|
|
201
|
+
- **Independent work runs in parallel.** Multiple `Agent` tool-use blocks in a single message. Sequential dispatching of independent units is wrong by default.
|
|
202
|
+
- **Multi-specialist work uses Teams.** Background `Agent` calls without `team_name` are blocked by the enforcement hook (see Multi-Agent Teams above).
|
|
203
|
+
- **Foreground agents** when the result blocks your next step. **Background agents** only inside Teams so `SendMessage` works.
|
|
204
|
+
|
|
205
|
+
### When to create a new skill or agent
|
|
206
|
+
|
|
207
|
+
Lift to a skill / agent instead of repeating instructions:
|
|
208
|
+
|
|
209
|
+
- **Same multi-step prompt twice in one session** → make a skill (`templates/skills/<category>/<name>/SKILL.md`).
|
|
210
|
+
- **Recurring class of work across projects** → make an agent definition (`.claude/agents/<role>.md`) and add a row to the delegation table above.
|
|
211
|
+
- **A workflow needs a specific persona / tool set** → agent. **A behavior modifier the user invokes on demand** → skill.
|
|
212
|
+
|
|
213
|
+
Default to creating, not improvising. The template scaffolding is cheap; ad-hoc context-window churn is expensive.
|
|
189
214
|
|
|
190
215
|
## Plans & Session Continuity
|
|
191
216
|
|
|
@@ -1,16 +1,16 @@
|
|
|
1
|
-
<!-- OVERRIDE:START -->
|
|
2
|
-
# Project-Specific Overrides
|
|
3
|
-
|
|
4
|
-
This file contains project-specific directives that take precedence over the generated AGENTS.md.
|
|
5
|
-
|
|
6
|
-
Add your custom rules, team conventions, or project-specific context here.
|
|
7
|
-
This file is NEVER overwritten by `rulebook init` or `rulebook update`.
|
|
8
|
-
|
|
9
|
-
## Example Overrides
|
|
10
|
-
|
|
11
|
-
- **Preferred patterns**: Always use X pattern for Y
|
|
12
|
-
- **Team conventions**: Code reviews require 2 approvals
|
|
13
|
-
- **Project context**: This project targets Node.js 20+ only
|
|
14
|
-
- **Custom quality gates**: Run `npm run e2e` before merging
|
|
15
|
-
|
|
16
|
-
<!-- OVERRIDE:END -->
|
|
1
|
+
<!-- OVERRIDE:START -->
|
|
2
|
+
# Project-Specific Overrides
|
|
3
|
+
|
|
4
|
+
This file contains project-specific directives that take precedence over the generated AGENTS.md.
|
|
5
|
+
|
|
6
|
+
Add your custom rules, team conventions, or project-specific context here.
|
|
7
|
+
This file is NEVER overwritten by `rulebook init` or `rulebook update`.
|
|
8
|
+
|
|
9
|
+
## Example Overrides
|
|
10
|
+
|
|
11
|
+
- **Preferred patterns**: Always use X pattern for Y
|
|
12
|
+
- **Team conventions**: Code reviews require 2 approvals
|
|
13
|
+
- **Project context**: This project targets Node.js 20+ only
|
|
14
|
+
- **Custom quality gates**: Run `npm run e2e` before merging
|
|
15
|
+
|
|
16
|
+
<!-- OVERRIDE:END -->
|
|
@@ -1,296 +1,296 @@
|
|
|
1
|
-
<!-- AGENT_AUTOMATION:START -->
|
|
2
|
-
# Agent Automation Rules
|
|
3
|
-
|
|
4
|
-
**CRITICAL**: Mandatory workflow that AI agents MUST execute after EVERY implementation.
|
|
5
|
-
|
|
6
|
-
## ⚠️ TOKEN OPTIMIZATION (MANDATORY FOR HAIKU)
|
|
7
|
-
|
|
8
|
-
**Claude Haiku has limited context. Every token counts.**
|
|
9
|
-
|
|
10
|
-
### Core Rules ✅
|
|
11
|
-
1. **Output code, not explanation** - Put logic in comments, not markdown
|
|
12
|
-
2. **Minimal reports** - Say "✅ Done" instead of detailed status reports
|
|
13
|
-
3. **No markdown abuse** - No unnecessary headings, tables, or emoji status lines
|
|
14
|
-
4. **Combine outputs** - One response instead of multiple small ones
|
|
15
|
-
5. **Comments > Documentation** - Use code comments for explaining logic
|
|
16
|
-
|
|
17
|
-
### Tokens Saved 💰
|
|
18
|
-
- Remove status emoji lines: **~500 tokens/task**
|
|
19
|
-
- Skip "Next Steps" sections: **~100 tokens/task**
|
|
20
|
-
- Eliminate markdown tables: **~200 tokens/task**
|
|
21
|
-
- Use concise commit messages: **~50 tokens/task**
|
|
22
|
-
|
|
23
|
-
**Total per task**: ~850 tokens saved = much more context for actual work
|
|
24
|
-
|
|
25
|
-
### Examples
|
|
26
|
-
|
|
27
|
-
❌ BAD (Wastes tokens):
|
|
28
|
-
```
|
|
29
|
-
✅ Implementation Complete
|
|
30
|
-
|
|
31
|
-
📝 Changes:
|
|
32
|
-
- Added UserService
|
|
33
|
-
- Added middleware
|
|
34
|
-
- Updated routes
|
|
35
|
-
|
|
36
|
-
🧪 Quality Checks:
|
|
37
|
-
- ✅ Type check: Passed
|
|
38
|
-
- ✅ Lint: 0 warnings
|
|
39
|
-
- ✅ Tests: 45/45 passed
|
|
40
|
-
- ✅ Coverage: 96%
|
|
41
|
-
```
|
|
42
|
-
|
|
43
|
-
✅ GOOD (Efficient):
|
|
44
|
-
```
|
|
45
|
-
✅ Done. UserService + middleware committed.
|
|
46
|
-
```
|
|
47
|
-
|
|
48
|
-
## Workflow Overview
|
|
49
|
-
|
|
50
|
-
After completing ANY feature, bug fix, or code change, execute this workflow in order:
|
|
51
|
-
|
|
52
|
-
### Step 1: Quality Checks (MANDATORY)
|
|
53
|
-
|
|
54
|
-
Run these checks in order - ALL must pass:
|
|
55
|
-
|
|
56
|
-
```bash
|
|
57
|
-
1. Type check (if applicable)
|
|
58
|
-
2. Lint (MUST pass with ZERO warnings)
|
|
59
|
-
3. Format code
|
|
60
|
-
4. Run ALL tests (MUST pass 100%)
|
|
61
|
-
5. Verify coverage meets threshold (default 95%)
|
|
62
|
-
```
|
|
63
|
-
|
|
64
|
-
**Language-specific commands**: See your language template (TYPESCRIPT, RUST, PYTHON, etc.) for exact commands.
|
|
65
|
-
|
|
66
|
-
**IF ANY CHECK FAILS:**
|
|
67
|
-
- ❌ STOP immediately
|
|
68
|
-
- ❌ DO NOT proceed
|
|
69
|
-
- ❌ DO NOT commit
|
|
70
|
-
- ✅ Fix the issue first
|
|
71
|
-
- ✅ Re-run ALL checks
|
|
72
|
-
|
|
73
|
-
**⚠️ TOKEN OPTIMIZATION**:
|
|
74
|
-
- Output only pass/fail status for each check
|
|
75
|
-
- Do NOT output detailed logs or test results
|
|
76
|
-
- Do NOT create status tables or emoji reports
|
|
77
|
-
- Use concise format: "✅ type-check pass" or "❌ tests fail: reason"
|
|
78
|
-
|
|
79
|
-
### Step 2: Capture to Persistent Memory
|
|
80
|
-
|
|
81
|
-
**IMPORTANT**: Save implementation insights and decisions to persistent memory for context across future sessions.
|
|
82
|
-
|
|
83
|
-
```bash
|
|
84
|
-
# 1. Identify key learnings from this implementation:
|
|
85
|
-
# - Design decisions made
|
|
86
|
-
# - Patterns discovered or applied
|
|
87
|
-
# - Gotchas or edge cases encountered
|
|
88
|
-
# - Performance insights
|
|
89
|
-
# - Test coverage notes
|
|
90
|
-
|
|
91
|
-
# 2. Save to memory (via MCP or CLI):
|
|
92
|
-
rulebook memory save "<content>" --type feature --title "Brief title" --tags tag1,tag2
|
|
93
|
-
|
|
94
|
-
# 3. Example:
|
|
95
|
-
rulebook memory save "Implemented OAuth token refresh with 30-min expiry. Key gotcha: tokens expire silently without warning on API calls - must check headers before retry. Pattern: Use interceptor middleware for transparent refresh." --type feature --title "OAuth token refresh implementation" --tags auth,oauth,gotchas
|
|
96
|
-
```
|
|
97
|
-
|
|
98
|
-
**Memory Auto-Capture**: If memory auto-capture is enabled in `.rulebook`, significant implementation outputs are automatically captured. Review and augment with additional context as needed.
|
|
99
|
-
|
|
100
|
-
### Step 3: Security & Dependency Audits
|
|
101
|
-
|
|
102
|
-
```bash
|
|
103
|
-
# Check for vulnerabilities (language-specific)
|
|
104
|
-
# Check for outdated dependencies (informational)
|
|
105
|
-
# Find unused dependencies (optional)
|
|
106
|
-
```
|
|
107
|
-
|
|
108
|
-
**Language-specific commands**: See your language template for audit commands.
|
|
109
|
-
|
|
110
|
-
**IF VULNERABILITIES FOUND:**
|
|
111
|
-
- ✅ Attempt automatic fix
|
|
112
|
-
- ✅ Document if auto-fix fails
|
|
113
|
-
- ✅ Include in Step 5 report
|
|
114
|
-
- ❌ Never ignore critical/high vulnerabilities without user approval
|
|
115
|
-
|
|
116
|
-
### Step 4: Update Rulebook Tasks
|
|
117
|
-
|
|
118
|
-
If using rulebook task management:
|
|
119
|
-
|
|
120
|
-
```bash
|
|
121
|
-
# Mark implemented tasks as completed
|
|
122
|
-
rulebook task update <task-id> --status completed
|
|
123
|
-
|
|
124
|
-
# Update any blocked/pending tasks
|
|
125
|
-
rulebook task update <task-id> --status blocked --reason "explanation"
|
|
126
|
-
```
|
|
127
|
-
|
|
128
|
-
**⚠️ CRITICAL: Follow the task sequence**
|
|
129
|
-
|
|
130
|
-
When working through a `tasks.md` checklist:
|
|
131
|
-
- Execute items in the EXACT order listed — top to bottom
|
|
132
|
-
- NEVER skip ahead, reorder, or cherry-pick "easier" tasks
|
|
133
|
-
- NEVER start Phase N+1 before Phase N is 100% complete
|
|
134
|
-
- The task list is an ORDER, not a MENU
|
|
135
|
-
|
|
136
|
-
### Step 5: Update OpenSpec Tasks
|
|
137
|
-
|
|
138
|
-
If `openspec/` directory exists:
|
|
139
|
-
|
|
140
|
-
```bash
|
|
141
|
-
# Mark completed tasks as [DONE]
|
|
142
|
-
# Update in-progress tasks
|
|
143
|
-
# Add new tasks if discovered
|
|
144
|
-
# Update progress percentages
|
|
145
|
-
# Document deviations or blockers
|
|
146
|
-
```
|
|
147
|
-
|
|
148
|
-
### Step 6: Update Documentation
|
|
149
|
-
|
|
150
|
-
```bash
|
|
151
|
-
# Update ROADMAP.md (if feature is milestone)
|
|
152
|
-
# Update CHANGELOG.md (conventional commits format)
|
|
153
|
-
# Update feature specs (if implementation differs)
|
|
154
|
-
# Update README.md (if public API changed)
|
|
155
|
-
```
|
|
156
|
-
|
|
157
|
-
### Step 7: Git Commit
|
|
158
|
-
|
|
159
|
-
**ONLY after ALL above steps pass:**
|
|
160
|
-
|
|
161
|
-
**⚠️ CRITICAL: All commit messages MUST be in English**
|
|
162
|
-
|
|
163
|
-
```bash
|
|
164
|
-
git add .
|
|
165
|
-
git commit -m "<type>(<scope>): <description>
|
|
166
|
-
|
|
167
|
-
- Detailed change 1
|
|
168
|
-
- Detailed change 2
|
|
169
|
-
- Tests: [describe coverage]
|
|
170
|
-
- Coverage: X% (threshold: 95%)
|
|
171
|
-
- Memory: [saved key learnings to persistent memory]
|
|
172
|
-
|
|
173
|
-
Closes #<issue> (if applicable)"
|
|
174
|
-
```
|
|
175
|
-
|
|
176
|
-
**Commit Types**: `feat`, `fix`, `docs`, `refactor`, `perf`, `test`, `build`, `ci`, `chore`
|
|
177
|
-
|
|
178
|
-
**Language Requirement**: Commit messages must be written in English. Never use Portuguese, Spanish, or any other language.
|
|
179
|
-
|
|
180
|
-
### Step 8: Report to User (Minimal Token Output)
|
|
181
|
-
|
|
182
|
-
**⚠️ CRITICAL: Minimize report to save tokens**
|
|
183
|
-
|
|
184
|
-
**✅ MINIMAL REPORT (Preferred - Saves ~500 tokens):**
|
|
185
|
-
```
|
|
186
|
-
✅ Done. Committed: <hash>
|
|
187
|
-
```
|
|
188
|
-
|
|
189
|
-
**✅ SHORT REPORT (If needed - Only ~100 tokens):**
|
|
190
|
-
```
|
|
191
|
-
✅ Implementation complete
|
|
192
|
-
- Files changed: X
|
|
193
|
-
- Tests: pass
|
|
194
|
-
- Coverage: X%
|
|
195
|
-
- Committed
|
|
196
|
-
```
|
|
197
|
-
|
|
198
|
-
**❌ NEVER OUTPUT LONG REPORTS (Wastes tokens):**
|
|
199
|
-
- ❌ Don't create "Implementation Complete" sections
|
|
200
|
-
- ❌ Don't list all quality checks with emojis
|
|
201
|
-
- ❌ Don't show commit messages verbatim
|
|
202
|
-
- ❌ Don't add "Next Steps" sections
|
|
203
|
-
- ❌ Don't create status tables or boxes
|
|
204
|
-
|
|
205
|
-
**Why**: Long reports add 500-1000+ tokens per task. For Haiku (limited context), use minimal format.
|
|
206
|
-
|
|
207
|
-
## Automation Exceptions
|
|
208
|
-
|
|
209
|
-
Skip steps ONLY when:
|
|
210
|
-
|
|
211
|
-
1. **Exploratory Code**: User says "experimental", "draft", "try"
|
|
212
|
-
- Still run quality checks
|
|
213
|
-
- Don't commit
|
|
214
|
-
|
|
215
|
-
2. **User Explicitly Requests**: User says "skip tests", "no commit"
|
|
216
|
-
- Only skip requested step
|
|
217
|
-
- Warn about skipped steps
|
|
218
|
-
|
|
219
|
-
3. **Emergency Hotfix**: Critical production bug
|
|
220
|
-
- Run minimal checks
|
|
221
|
-
- Document technical debt
|
|
222
|
-
|
|
223
|
-
**In ALL other cases: Execute complete workflow**
|
|
224
|
-
|
|
225
|
-
## Error Recovery
|
|
226
|
-
|
|
227
|
-
If workflow fails 3+ times:
|
|
228
|
-
|
|
229
|
-
```bash
|
|
230
|
-
1. Create backup branch
|
|
231
|
-
2. Reset to last stable commit
|
|
232
|
-
3. Report to user with error details
|
|
233
|
-
4. Request guidance or try alternative approach
|
|
234
|
-
```
|
|
235
|
-
|
|
236
|
-
## Best Practices
|
|
237
|
-
|
|
238
|
-
### DO's ✅
|
|
239
|
-
- ALWAYS run complete workflow
|
|
240
|
-
- ALWAYS update OpenSpec and documentation
|
|
241
|
-
- ALWAYS use conventional commits
|
|
242
|
-
- ALWAYS report summary to user
|
|
243
|
-
- ASK before skipping steps
|
|
244
|
-
|
|
245
|
-
### DON'Ts ❌
|
|
246
|
-
- NEVER skip quality checks without permission
|
|
247
|
-
- NEVER commit failing tests
|
|
248
|
-
- NEVER commit linting errors
|
|
249
|
-
- NEVER skip documentation updates
|
|
250
|
-
- NEVER assume user wants to skip automation
|
|
251
|
-
- NEVER commit debug code or secrets
|
|
252
|
-
|
|
253
|
-
## Summary
|
|
254
|
-
|
|
255
|
-
**Complete workflow after EVERY implementation:**
|
|
256
|
-
|
|
257
|
-
1. ✅ Quality checks (type, lint, format, test, coverage)
|
|
258
|
-
2. ✅ Capture to persistent memory (save learnings and decisions)
|
|
259
|
-
3. ✅ Security audit
|
|
260
|
-
4. ✅ Update rulebook tasks
|
|
261
|
-
5. ✅ Update OpenSpec tasks (if applicable)
|
|
262
|
-
6. ✅ Update documentation
|
|
263
|
-
7. ✅ Git commit (conventional format)
|
|
264
|
-
8. ✅ Report summary to user
|
|
265
|
-
|
|
266
|
-
**Only skip with explicit user permission and document why.**
|
|
267
|
-
|
|
268
|
-
## Persistent Memory Best Practices
|
|
269
|
-
|
|
270
|
-
### What to Capture
|
|
271
|
-
- **Design decisions**: Why a particular approach was chosen
|
|
272
|
-
- **Patterns**: Reusable solutions discovered during implementation
|
|
273
|
-
- **Gotchas**: Edge cases, limitations, or surprising behaviors
|
|
274
|
-
- **Performance insights**: Optimization lessons or bottleneck discoveries
|
|
275
|
-
- **Bug fixes**: Root cause and resolution for future reference
|
|
276
|
-
|
|
277
|
-
### How to Capture
|
|
278
|
-
```bash
|
|
279
|
-
# Via CLI
|
|
280
|
-
rulebook memory save "<detailed content>" --type <type> --title "Short title" --tags tag1,tag2
|
|
281
|
-
|
|
282
|
-
# Memory types: bugfix, feature, refactor, decision, discovery, change, observation
|
|
283
|
-
|
|
284
|
-
# Example: Feature capture
|
|
285
|
-
rulebook memory save "Implemented async batch processing for large datasets. Pattern: use queue with worker threads (maxWorkers=4). Gotcha: Queue memory grows unbounded - added max size limit with drop strategy. Tests: Added batch-size edge cases." --type feature --title "Async batch processing implementation" --tags performance,queues,patterns
|
|
286
|
-
```
|
|
287
|
-
|
|
288
|
-
### Search Previous Context
|
|
289
|
-
Before implementing similar features, search memory for past learnings:
|
|
290
|
-
```bash
|
|
291
|
-
rulebook memory search "batch processing" --mode hybrid
|
|
292
|
-
```
|
|
293
|
-
|
|
294
|
-
This surfaces past decisions and patterns to avoid redundant work and preserve institutional knowledge.
|
|
295
|
-
|
|
296
|
-
<!-- AGENT_AUTOMATION:END -->
|
|
1
|
+
<!-- AGENT_AUTOMATION:START -->
|
|
2
|
+
# Agent Automation Rules
|
|
3
|
+
|
|
4
|
+
**CRITICAL**: Mandatory workflow that AI agents MUST execute after EVERY implementation.
|
|
5
|
+
|
|
6
|
+
## ⚠️ TOKEN OPTIMIZATION (MANDATORY FOR HAIKU)
|
|
7
|
+
|
|
8
|
+
**Claude Haiku has limited context. Every token counts.**
|
|
9
|
+
|
|
10
|
+
### Core Rules ✅
|
|
11
|
+
1. **Output code, not explanation** - Put logic in comments, not markdown
|
|
12
|
+
2. **Minimal reports** - Say "✅ Done" instead of detailed status reports
|
|
13
|
+
3. **No markdown abuse** - No unnecessary headings, tables, or emoji status lines
|
|
14
|
+
4. **Combine outputs** - One response instead of multiple small ones
|
|
15
|
+
5. **Comments > Documentation** - Use code comments for explaining logic
|
|
16
|
+
|
|
17
|
+
### Tokens Saved 💰
|
|
18
|
+
- Remove status emoji lines: **~500 tokens/task**
|
|
19
|
+
- Skip "Next Steps" sections: **~100 tokens/task**
|
|
20
|
+
- Eliminate markdown tables: **~200 tokens/task**
|
|
21
|
+
- Use concise commit messages: **~50 tokens/task**
|
|
22
|
+
|
|
23
|
+
**Total per task**: ~850 tokens saved = much more context for actual work
|
|
24
|
+
|
|
25
|
+
### Examples
|
|
26
|
+
|
|
27
|
+
❌ BAD (Wastes tokens):
|
|
28
|
+
```
|
|
29
|
+
✅ Implementation Complete
|
|
30
|
+
|
|
31
|
+
📝 Changes:
|
|
32
|
+
- Added UserService
|
|
33
|
+
- Added middleware
|
|
34
|
+
- Updated routes
|
|
35
|
+
|
|
36
|
+
🧪 Quality Checks:
|
|
37
|
+
- ✅ Type check: Passed
|
|
38
|
+
- ✅ Lint: 0 warnings
|
|
39
|
+
- ✅ Tests: 45/45 passed
|
|
40
|
+
- ✅ Coverage: 96%
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
✅ GOOD (Efficient):
|
|
44
|
+
```
|
|
45
|
+
✅ Done. UserService + middleware committed.
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
## Workflow Overview
|
|
49
|
+
|
|
50
|
+
After completing ANY feature, bug fix, or code change, execute this workflow in order:
|
|
51
|
+
|
|
52
|
+
### Step 1: Quality Checks (MANDATORY)
|
|
53
|
+
|
|
54
|
+
Run these checks in order - ALL must pass:
|
|
55
|
+
|
|
56
|
+
```bash
|
|
57
|
+
1. Type check (if applicable)
|
|
58
|
+
2. Lint (MUST pass with ZERO warnings)
|
|
59
|
+
3. Format code
|
|
60
|
+
4. Run ALL tests (MUST pass 100%)
|
|
61
|
+
5. Verify coverage meets threshold (default 95%)
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
**Language-specific commands**: See your language template (TYPESCRIPT, RUST, PYTHON, etc.) for exact commands.
|
|
65
|
+
|
|
66
|
+
**IF ANY CHECK FAILS:**
|
|
67
|
+
- ❌ STOP immediately
|
|
68
|
+
- ❌ DO NOT proceed
|
|
69
|
+
- ❌ DO NOT commit
|
|
70
|
+
- ✅ Fix the issue first
|
|
71
|
+
- ✅ Re-run ALL checks
|
|
72
|
+
|
|
73
|
+
**⚠️ TOKEN OPTIMIZATION**:
|
|
74
|
+
- Output only pass/fail status for each check
|
|
75
|
+
- Do NOT output detailed logs or test results
|
|
76
|
+
- Do NOT create status tables or emoji reports
|
|
77
|
+
- Use concise format: "✅ type-check pass" or "❌ tests fail: reason"
|
|
78
|
+
|
|
79
|
+
### Step 2: Capture to Persistent Memory
|
|
80
|
+
|
|
81
|
+
**IMPORTANT**: Save implementation insights and decisions to persistent memory for context across future sessions.
|
|
82
|
+
|
|
83
|
+
```bash
|
|
84
|
+
# 1. Identify key learnings from this implementation:
|
|
85
|
+
# - Design decisions made
|
|
86
|
+
# - Patterns discovered or applied
|
|
87
|
+
# - Gotchas or edge cases encountered
|
|
88
|
+
# - Performance insights
|
|
89
|
+
# - Test coverage notes
|
|
90
|
+
|
|
91
|
+
# 2. Save to memory (via MCP or CLI):
|
|
92
|
+
rulebook memory save "<content>" --type feature --title "Brief title" --tags tag1,tag2
|
|
93
|
+
|
|
94
|
+
# 3. Example:
|
|
95
|
+
rulebook memory save "Implemented OAuth token refresh with 30-min expiry. Key gotcha: tokens expire silently without warning on API calls - must check headers before retry. Pattern: Use interceptor middleware for transparent refresh." --type feature --title "OAuth token refresh implementation" --tags auth,oauth,gotchas
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
**Memory Auto-Capture**: If memory auto-capture is enabled in `.rulebook`, significant implementation outputs are automatically captured. Review and augment with additional context as needed.
|
|
99
|
+
|
|
100
|
+
### Step 3: Security & Dependency Audits
|
|
101
|
+
|
|
102
|
+
```bash
|
|
103
|
+
# Check for vulnerabilities (language-specific)
|
|
104
|
+
# Check for outdated dependencies (informational)
|
|
105
|
+
# Find unused dependencies (optional)
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
**Language-specific commands**: See your language template for audit commands.
|
|
109
|
+
|
|
110
|
+
**IF VULNERABILITIES FOUND:**
|
|
111
|
+
- ✅ Attempt automatic fix
|
|
112
|
+
- ✅ Document if auto-fix fails
|
|
113
|
+
- ✅ Include in Step 5 report
|
|
114
|
+
- ❌ Never ignore critical/high vulnerabilities without user approval
|
|
115
|
+
|
|
116
|
+
### Step 4: Update Rulebook Tasks
|
|
117
|
+
|
|
118
|
+
If using rulebook task management:
|
|
119
|
+
|
|
120
|
+
```bash
|
|
121
|
+
# Mark implemented tasks as completed
|
|
122
|
+
rulebook task update <task-id> --status completed
|
|
123
|
+
|
|
124
|
+
# Update any blocked/pending tasks
|
|
125
|
+
rulebook task update <task-id> --status blocked --reason "explanation"
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
**⚠️ CRITICAL: Follow the task sequence**
|
|
129
|
+
|
|
130
|
+
When working through a `tasks.md` checklist:
|
|
131
|
+
- Execute items in the EXACT order listed — top to bottom
|
|
132
|
+
- NEVER skip ahead, reorder, or cherry-pick "easier" tasks
|
|
133
|
+
- NEVER start Phase N+1 before Phase N is 100% complete
|
|
134
|
+
- The task list is an ORDER, not a MENU
|
|
135
|
+
|
|
136
|
+
### Step 5: Update OpenSpec Tasks
|
|
137
|
+
|
|
138
|
+
If `openspec/` directory exists:
|
|
139
|
+
|
|
140
|
+
```bash
|
|
141
|
+
# Mark completed tasks as [DONE]
|
|
142
|
+
# Update in-progress tasks
|
|
143
|
+
# Add new tasks if discovered
|
|
144
|
+
# Update progress percentages
|
|
145
|
+
# Document deviations or blockers
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
### Step 6: Update Documentation
|
|
149
|
+
|
|
150
|
+
```bash
|
|
151
|
+
# Update ROADMAP.md (if feature is milestone)
|
|
152
|
+
# Update CHANGELOG.md (conventional commits format)
|
|
153
|
+
# Update feature specs (if implementation differs)
|
|
154
|
+
# Update README.md (if public API changed)
|
|
155
|
+
```
|
|
156
|
+
|
|
157
|
+
### Step 7: Git Commit
|
|
158
|
+
|
|
159
|
+
**ONLY after ALL above steps pass:**
|
|
160
|
+
|
|
161
|
+
**⚠️ CRITICAL: All commit messages MUST be in English**
|
|
162
|
+
|
|
163
|
+
```bash
|
|
164
|
+
git add .
|
|
165
|
+
git commit -m "<type>(<scope>): <description>
|
|
166
|
+
|
|
167
|
+
- Detailed change 1
|
|
168
|
+
- Detailed change 2
|
|
169
|
+
- Tests: [describe coverage]
|
|
170
|
+
- Coverage: X% (threshold: 95%)
|
|
171
|
+
- Memory: [saved key learnings to persistent memory]
|
|
172
|
+
|
|
173
|
+
Closes #<issue> (if applicable)"
|
|
174
|
+
```
|
|
175
|
+
|
|
176
|
+
**Commit Types**: `feat`, `fix`, `docs`, `refactor`, `perf`, `test`, `build`, `ci`, `chore`
|
|
177
|
+
|
|
178
|
+
**Language Requirement**: Commit messages must be written in English. Never use Portuguese, Spanish, or any other language.
|
|
179
|
+
|
|
180
|
+
### Step 8: Report to User (Minimal Token Output)
|
|
181
|
+
|
|
182
|
+
**⚠️ CRITICAL: Minimize report to save tokens**
|
|
183
|
+
|
|
184
|
+
**✅ MINIMAL REPORT (Preferred - Saves ~500 tokens):**
|
|
185
|
+
```
|
|
186
|
+
✅ Done. Committed: <hash>
|
|
187
|
+
```
|
|
188
|
+
|
|
189
|
+
**✅ SHORT REPORT (If needed - Only ~100 tokens):**
|
|
190
|
+
```
|
|
191
|
+
✅ Implementation complete
|
|
192
|
+
- Files changed: X
|
|
193
|
+
- Tests: pass
|
|
194
|
+
- Coverage: X%
|
|
195
|
+
- Committed
|
|
196
|
+
```
|
|
197
|
+
|
|
198
|
+
**❌ NEVER OUTPUT LONG REPORTS (Wastes tokens):**
|
|
199
|
+
- ❌ Don't create "Implementation Complete" sections
|
|
200
|
+
- ❌ Don't list all quality checks with emojis
|
|
201
|
+
- ❌ Don't show commit messages verbatim
|
|
202
|
+
- ❌ Don't add "Next Steps" sections
|
|
203
|
+
- ❌ Don't create status tables or boxes
|
|
204
|
+
|
|
205
|
+
**Why**: Long reports add 500-1000+ tokens per task. For Haiku (limited context), use minimal format.
|
|
206
|
+
|
|
207
|
+
## Automation Exceptions
|
|
208
|
+
|
|
209
|
+
Skip steps ONLY when:
|
|
210
|
+
|
|
211
|
+
1. **Exploratory Code**: User says "experimental", "draft", "try"
|
|
212
|
+
- Still run quality checks
|
|
213
|
+
- Don't commit
|
|
214
|
+
|
|
215
|
+
2. **User Explicitly Requests**: User says "skip tests", "no commit"
|
|
216
|
+
- Only skip requested step
|
|
217
|
+
- Warn about skipped steps
|
|
218
|
+
|
|
219
|
+
3. **Emergency Hotfix**: Critical production bug
|
|
220
|
+
- Run minimal checks
|
|
221
|
+
- Document technical debt
|
|
222
|
+
|
|
223
|
+
**In ALL other cases: Execute complete workflow**
|
|
224
|
+
|
|
225
|
+
## Error Recovery
|
|
226
|
+
|
|
227
|
+
If workflow fails 3+ times:
|
|
228
|
+
|
|
229
|
+
```bash
|
|
230
|
+
1. Create backup branch
|
|
231
|
+
2. Reset to last stable commit
|
|
232
|
+
3. Report to user with error details
|
|
233
|
+
4. Request guidance or try alternative approach
|
|
234
|
+
```
|
|
235
|
+
|
|
236
|
+
## Best Practices
|
|
237
|
+
|
|
238
|
+
### DO's ✅
|
|
239
|
+
- ALWAYS run complete workflow
|
|
240
|
+
- ALWAYS update OpenSpec and documentation
|
|
241
|
+
- ALWAYS use conventional commits
|
|
242
|
+
- ALWAYS report summary to user
|
|
243
|
+
- ASK before skipping steps
|
|
244
|
+
|
|
245
|
+
### DON'Ts ❌
|
|
246
|
+
- NEVER skip quality checks without permission
|
|
247
|
+
- NEVER commit failing tests
|
|
248
|
+
- NEVER commit linting errors
|
|
249
|
+
- NEVER skip documentation updates
|
|
250
|
+
- NEVER assume user wants to skip automation
|
|
251
|
+
- NEVER commit debug code or secrets
|
|
252
|
+
|
|
253
|
+
## Summary
|
|
254
|
+
|
|
255
|
+
**Complete workflow after EVERY implementation:**
|
|
256
|
+
|
|
257
|
+
1. ✅ Quality checks (type, lint, format, test, coverage)
|
|
258
|
+
2. ✅ Capture to persistent memory (save learnings and decisions)
|
|
259
|
+
3. ✅ Security audit
|
|
260
|
+
4. ✅ Update rulebook tasks
|
|
261
|
+
5. ✅ Update OpenSpec tasks (if applicable)
|
|
262
|
+
6. ✅ Update documentation
|
|
263
|
+
7. ✅ Git commit (conventional format)
|
|
264
|
+
8. ✅ Report summary to user
|
|
265
|
+
|
|
266
|
+
**Only skip with explicit user permission and document why.**
|
|
267
|
+
|
|
268
|
+
## Persistent Memory Best Practices
|
|
269
|
+
|
|
270
|
+
### What to Capture
|
|
271
|
+
- **Design decisions**: Why a particular approach was chosen
|
|
272
|
+
- **Patterns**: Reusable solutions discovered during implementation
|
|
273
|
+
- **Gotchas**: Edge cases, limitations, or surprising behaviors
|
|
274
|
+
- **Performance insights**: Optimization lessons or bottleneck discoveries
|
|
275
|
+
- **Bug fixes**: Root cause and resolution for future reference
|
|
276
|
+
|
|
277
|
+
### How to Capture
|
|
278
|
+
```bash
|
|
279
|
+
# Via CLI
|
|
280
|
+
rulebook memory save "<detailed content>" --type <type> --title "Short title" --tags tag1,tag2
|
|
281
|
+
|
|
282
|
+
# Memory types: bugfix, feature, refactor, decision, discovery, change, observation
|
|
283
|
+
|
|
284
|
+
# Example: Feature capture
|
|
285
|
+
rulebook memory save "Implemented async batch processing for large datasets. Pattern: use queue with worker threads (maxWorkers=4). Gotcha: Queue memory grows unbounded - added max size limit with drop strategy. Tests: Added batch-size edge cases." --type feature --title "Async batch processing implementation" --tags performance,queues,patterns
|
|
286
|
+
```
|
|
287
|
+
|
|
288
|
+
### Search Previous Context
|
|
289
|
+
Before implementing similar features, search memory for past learnings:
|
|
290
|
+
```bash
|
|
291
|
+
rulebook memory search "batch processing" --mode hybrid
|
|
292
|
+
```
|
|
293
|
+
|
|
294
|
+
This surfaces past decisions and patterns to avoid redundant work and preserve institutional knowledge.
|
|
295
|
+
|
|
296
|
+
<!-- AGENT_AUTOMATION:END -->
|