@hivehub/rulebook 5.8.1 → 6.0.0

package/templates/core/DOCUMENTATION_RULES.md

@@ -1,37 +1,37 @@
-# Documentation Standards
-
-**CRITICAL**: All documentation in English. Root README concise, detailed docs in `/docs`.
-
-## Structure
-
-**Root-Level (ONLY):**
-- `README.md` - Overview + quick start
-- `CHANGELOG.md` - Version history
-- `AGENTS.md` - AI instructions
-- `LICENSE`, `CONTRIBUTING.md`, `SECURITY.md`
-
-**All Other Docs in `/docs`:**
-- `ARCHITECTURE.md`, `DEVELOPMENT.md`, `ROADMAP.md`
-- `specs/`, `guides/`, `diagrams/`, `benchmarks/`
-
-## Update Requirements by Commit Type
-
-| Type | Update |
-|------|--------|
-| `feat` | README features, API docs, CHANGELOG "Added" |
-| `fix` | Troubleshooting, CHANGELOG "Fixed" |
-| `breaking` | CHANGELOG + migration guide, version docs |
-| `perf` | Benchmarks, CHANGELOG "Performance" |
-| `security` | SECURITY.md, CHANGELOG "Security" |
-| `docs` | Verify spelling/links only |
-| `refactor` | Update if behavior changed |
-
-## Quality Checks (CI/CD)
-
-```bash
-markdownlint **/*.md         # Lint markdown
-markdown-link-check **/*.md  # Check links
-codespell **/*.md            # Spell check
-```
-
+# Documentation Standards
+
+**CRITICAL**: All documentation in English. Root README concise, detailed docs in `/docs`.
+
+## Structure
+
+**Root-Level (ONLY):**
+- `README.md` - Overview + quick start
+- `CHANGELOG.md` - Version history
+- `AGENTS.md` - AI instructions
+- `LICENSE`, `CONTRIBUTING.md`, `SECURITY.md`
+
+**All Other Docs in `/docs`:**
+- `ARCHITECTURE.md`, `DEVELOPMENT.md`, `ROADMAP.md`
+- `specs/`, `guides/`, `diagrams/`, `benchmarks/`
+
+## Update Requirements by Commit Type
+
+| Type | Update |
+|------|--------|
+| `feat` | README features, API docs, CHANGELOG "Added" |
+| `fix` | Troubleshooting, CHANGELOG "Fixed" |
+| `breaking` | CHANGELOG + migration guide, version docs |
+| `perf` | Benchmarks, CHANGELOG "Performance" |
+| `security` | SECURITY.md, CHANGELOG "Security" |
+| `docs` | Verify spelling/links only |
+| `refactor` | Update if behavior changed |
+
+## Quality Checks (CI/CD)
+
+```bash
+markdownlint **/*.md         # Lint markdown
+markdown-link-check **/*.md  # Check links
+codespell **/*.md            # Spell check
+```
+
 **MUST pass before commit** (see AGENT_AUTOMATION).

package/templates/core/KNOWLEDGE.md

@@ -1,49 +1,49 @@
-# Project Knowledge Base
-
-This project maintains an explicit knowledge base of patterns and anti-patterns.
-
-## Structure
-
-```
-.rulebook/knowledge/
-├── patterns/           # Approved patterns to follow
-│   ├── <slug>.md
-│   └── <slug>.metadata.json
-└── anti-patterns/      # Known anti-patterns to avoid
-    ├── <slug>.md
-    └── <slug>.metadata.json
-```
-
-## Entry Format
-
-Each knowledge entry includes:
-- **Description**: What the pattern/anti-pattern is
-- **Example**: Code showing correct (or incorrect) usage
-- **When to Use**: Situations where this pattern applies
-- **When NOT to Use**: Exceptions and edge cases
-
-## Categories
-
-- `architecture` — System-level design patterns
-- `code` — Code-level patterns and idioms
-- `testing` — Testing strategies and patterns
-- `security` — Security patterns and practices
-- `performance` — Performance optimization patterns
-- `devops` — Infrastructure and deployment patterns
-
-## Commands
-
-```bash
-rulebook knowledge add pattern "Repository Pattern" --category architecture
-rulebook knowledge add anti-pattern "God Object" --category code
-rulebook knowledge list --type pattern
-rulebook knowledge show repository-pattern
-rulebook knowledge remove god-object
-```
-
-## Rules
-
-1. Patterns added here are auto-injected into AGENTS.md on `rulebook update`
-2. AI assistants should follow patterns and avoid anti-patterns
-3. Include concrete examples — abstract descriptions are less useful
-4. Tag entries for searchability
+# Project Knowledge Base
+
+This project maintains an explicit knowledge base of patterns and anti-patterns.
+
+## Structure
+
+```
+.rulebook/knowledge/
+├── patterns/           # Approved patterns to follow
+│   ├── <slug>.md
+│   └── <slug>.metadata.json
+└── anti-patterns/      # Known anti-patterns to avoid
+    ├── <slug>.md
+    └── <slug>.metadata.json
+```
+
+## Entry Format
+
+Each knowledge entry includes:
+- **Description**: What the pattern/anti-pattern is
+- **Example**: Code showing correct (or incorrect) usage
+- **When to Use**: Situations where this pattern applies
+- **When NOT to Use**: Exceptions and edge cases
+
+## Categories
+
+- `architecture` — System-level design patterns
+- `code` — Code-level patterns and idioms
+- `testing` — Testing strategies and patterns
+- `security` — Security patterns and practices
+- `performance` — Performance optimization patterns
+- `devops` — Infrastructure and deployment patterns
+
+## Commands
+
+```bash
+rulebook knowledge add pattern "Repository Pattern" --category architecture
+rulebook knowledge add anti-pattern "God Object" --category code
+rulebook knowledge list --type pattern
+rulebook knowledge show repository-pattern
+rulebook knowledge remove god-object
+```
+
+## Rules
+
+1. Patterns added here are auto-injected into AGENTS.md on `rulebook update`
+2. AI assistants should follow patterns and avoid anti-patterns
+3. Include concrete examples — abstract descriptions are less useful
+4. Tag entries for searchability

package/templates/core/MULTI_AGENT.md

@@ -1,74 +1,74 @@
-<!-- MULTI_AGENT:START -->
-# Multi-Agent Development Directives
-
-## Overview
-
-When `CLAUDE_CODE_EXPERIMENTAL_AGENT_TEAMS` is enabled, Claude Code can spawn specialized sub-agents that work in parallel on complex tasks. This template defines coordination rules and team patterns for effective multi-agent development.
-
-## When to Use Teams
-
-Use agent teams when:
-- Tasks have clear parallel work streams (e.g., frontend + backend simultaneously)
-- Research, implementation, and testing can run concurrently
-- Multiple independent modules need changes at the same time
-- Complex refactoring spans many files across different subsystems
-
-Do NOT use teams when:
-- The task is simple and sequential
-- Changes are tightly coupled and require serial execution
-- The task can be completed in under 5 minutes by a single agent
-
-## Team Structure Patterns
-
-### Standard Team (Recommended)
-
-| Agent | Role | Responsibilities |
-|-------|------|-----------------|
-| **team-lead** | Orchestrator | Breaks down tasks, assigns work, integrates results |
-| **researcher** | Information Gatherer | Reads code, searches docs, analyzes patterns |
-| **implementer** | Code Writer | Writes production code following established patterns |
-| **tester** | Quality Assurance | Writes tests, validates coverage, runs quality checks |
-
-### Minimal Team (Simple Tasks)
-
-| Agent | Role |
-|-------|------|
-| **team-lead** | Orchestrator + integrator |
-| **implementer** | Code writer + researcher |
-
-## Coordination Rules
-
-1. **Team lead assigns tasks explicitly** -- agents do not self-assign work
-2. **Agents report completion via SendMessage** -- not by writing to shared files
-3. **No two agents modify the same file simultaneously** -- team lead coordinates file ownership
-4. **Use git-friendly workflows** -- each agent works on distinct files to avoid merge conflicts
-5. **Quality gates are mandatory** -- tester agent validates all changes before completion
-
-## Communication Protocol
-
-- **Task Assignment**: Team lead sends specific, scoped instructions to each agent
-- **Progress Updates**: Agents report status via messages, not file-based communication
-- **Blocking Issues**: Agents immediately notify team lead of blockers
-- **Completion**: Agents send explicit "done" messages with summary of changes
-
-## File Ownership
-
-To prevent conflicts, the team lead must:
-1. Identify all files that need modification
-2. Assign exclusive ownership of each file to one agent
-3. If multiple agents need the same file, serialize their access
-
-## Agent Definitions
-
-Pre-configured agent definitions are available in `.claude/agents/`. These provide specialized instructions for each agent role, ensuring consistent behavior and expertise.
-
-## Quality Enforcement
-
-All agent teams must adhere to the project's quality gates:
-- Type checking must pass
-- Linter must pass with zero warnings
-- All tests must pass
-- Coverage thresholds must be met
-
-The tester agent is responsible for running these checks before the team lead marks a task as complete.
-<!-- MULTI_AGENT:END -->
+<!-- MULTI_AGENT:START -->
+# Multi-Agent Development Directives
+
+## Overview
+
+When `CLAUDE_CODE_EXPERIMENTAL_AGENT_TEAMS` is enabled, Claude Code can spawn specialized sub-agents that work in parallel on complex tasks. This template defines coordination rules and team patterns for effective multi-agent development.
+
+## When to Use Teams
+
+Use agent teams when:
+- Tasks have clear parallel work streams (e.g., frontend + backend simultaneously)
+- Research, implementation, and testing can run concurrently
+- Multiple independent modules need changes at the same time
+- Complex refactoring spans many files across different subsystems
+
+Do NOT use teams when:
+- The task is simple and sequential
+- Changes are tightly coupled and require serial execution
+- The task can be completed in under 5 minutes by a single agent
+
+## Team Structure Patterns
+
+### Standard Team (Recommended)
+
+| Agent | Role | Responsibilities |
+|-------|------|-----------------|
+| **team-lead** | Orchestrator | Breaks down tasks, assigns work, integrates results |
+| **researcher** | Information Gatherer | Reads code, searches docs, analyzes patterns |
+| **implementer** | Code Writer | Writes production code following established patterns |
+| **tester** | Quality Assurance | Writes tests, validates coverage, runs quality checks |
+
+### Minimal Team (Simple Tasks)
+
+| Agent | Role |
+|-------|------|
+| **team-lead** | Orchestrator + integrator |
+| **implementer** | Code writer + researcher |
+
+## Coordination Rules
+
+1. **Team lead assigns tasks explicitly** -- agents do not self-assign work
+2. **Agents report completion via SendMessage** -- not by writing to shared files
+3. **No two agents modify the same file simultaneously** -- team lead coordinates file ownership
+4. **Use git-friendly workflows** -- each agent works on distinct files to avoid merge conflicts
+5. **Quality gates are mandatory** -- tester agent validates all changes before completion
+
+## Communication Protocol
+
+- **Task Assignment**: Team lead sends specific, scoped instructions to each agent
+- **Progress Updates**: Agents report status via messages, not file-based communication
+- **Blocking Issues**: Agents immediately notify team lead of blockers
+- **Completion**: Agents send explicit "done" messages with summary of changes
+
+## File Ownership
+
+To prevent conflicts, the team lead must:
+1. Identify all files that need modification
+2. Assign exclusive ownership of each file to one agent
+3. If multiple agents need the same file, serialize their access
+
+## Agent Definitions
+
+Pre-configured agent definitions are available in `.claude/agents/`. These provide specialized instructions for each agent role, ensuring consistent behavior and expertise.
+
+## Quality Enforcement
+
+All agent teams must adhere to the project's quality gates:
+- Type checking must pass
+- Linter must pass with zero warnings
+- All tests must pass
+- Coverage thresholds must be met
+
+The tester agent is responsible for running these checks before the team lead marks a task as complete.
+<!-- MULTI_AGENT:END -->

package/templates/core/PLANS.md

@@ -1,28 +1,28 @@
-<!-- PLANS:START -->
-# Project Plans & Session Context
-
-This file is a **persistent session scratchpad** maintained by AI agents.
-It provides continuity across sessions without relying on conversation history.
-
-## How to Use
-
-At the **start of each session**: Read this file to understand current context.
-During the **session**: Update with decisions, discoveries, and progress.
-At **session end**: Write a summary to the Session History section.
-
-## Active Context
-
-<!-- PLANS:CONTEXT:START -->
-_No active context. Start a session to populate this section._
-<!-- PLANS:CONTEXT:END -->
-
-## Current Task
-
-<!-- PLANS:TASK:START -->
-_No task in progress._
-<!-- PLANS:TASK:END -->
-
-## Session History
-
-<!-- PLANS:HISTORY:START -->
-<!-- PLANS:HISTORY:END -->
+<!-- PLANS:START -->
+# Project Plans & Session Context
+
+This file is a **persistent session scratchpad** maintained by AI agents.
+It provides continuity across sessions without relying on conversation history.
+
+## How to Use
+
+At the **start of each session**: Read this file to understand current context.
+During the **session**: Update with decisions, discoveries, and progress.
+At **session end**: Write a summary to the Session History section.
+
+## Active Context
+
+<!-- PLANS:CONTEXT:START -->
+_No active context. Start a session to populate this section._
+<!-- PLANS:CONTEXT:END -->
+
+## Current Task
+
+<!-- PLANS:TASK:START -->
+_No task in progress._
+<!-- PLANS:TASK:END -->
+
+## Session History
+
+<!-- PLANS:HISTORY:START -->
+<!-- PLANS:HISTORY:END -->

package/templates/core/QUALITY_ENFORCEMENT.md

@@ -1,68 +1,68 @@
-<!-- QUALITY_ENFORCEMENT:START -->
-# Quality Enforcement Rules
-
-**CRITICAL**: These rules are NON-NEGOTIABLE and MUST be followed without exception.
-
-## Absolute Prohibitions
-
-### Test Bypassing - STRICTLY FORBIDDEN
-- NEVER use .skip(), .only(), or .todo() to bypass failing tests
-- NEVER comment out failing tests
-- NEVER use @ts-ignore, @ts-expect-error, or similar to hide test errors
-- NEVER mock/stub functionality just to make tests pass without fixing root cause
-- FIX the actual problem causing test failures
-
-### Git Hook Bypassing - STRICTLY FORBIDDEN  
-- NEVER use --no-verify flag on git commit
-- NEVER use --no-verify flag on git push
-- NEVER disable or skip pre-commit hooks
-- NEVER disable or skip pre-push hooks
-- FIX the issues that hooks are detecting
-
-### Test Implementation - STRICTLY FORBIDDEN
-- NEVER create boilerplate tests that don't actually test behavior
-- NEVER write tests that always pass regardless of implementation
-- NEVER write tests without assertions
-- NEVER mock everything to avoid testing real behavior
-- WRITE meaningful tests that verify actual functionality
-
-### Problem Solving Approach - REQUIRED
-- DO NOT seek the simplest bypass or workaround
-- DO NOT be creative with shortcuts that compromise quality
-- DO solve problems properly following best practices
-- DO use proven, established solutions from decades of experience
-- DO fix root causes, not symptoms
-
-### Temporary Files and Scripts - STRICTLY FORBIDDEN
-- **NEVER** create temporary files in project root or any directory outside `/scripts`
-- **NEVER** create test files, log files, or debug files outside `/scripts`
-- **NEVER** leave temporary files after use - they MUST be deleted immediately
-- **ALWAYS** create all scripts inside `/scripts` directory
-- **ALWAYS** remove temporary files immediately after use (MANDATORY)
-- **ALWAYS** clean up test artifacts, log files, and debug files before committing
-- **ALWAYS** use `/scripts` directory for any temporary scripts or test files
-
-**Why This Matters:**
-LLM assistants often create temporary files for testing but forget to remove them, accumulating dozens of junk files that pollute the repository. All temporary work MUST be done in `/scripts` and cleaned up immediately.
-
-**Examples:**
-- ❌ Creating `test.js`, `debug.log`, `temp.json` in project root
-- ❌ Leaving test files after debugging
-- ❌ Creating scripts outside `/scripts` directory
-- ✅ Creating `/scripts/test-feature.js` and removing it after use
-- ✅ Using `/scripts` for all temporary work
-- ✅ Cleaning up all temporary files before committing
-
-## Enforcement
-
-These rules apply to ALL implementations:
-- Bug fixes
-- New features  
-- Refactoring
-- Documentation changes
-- Any code modifications
-
-**Violation = Implementation Rejected**
-
-<!-- QUALITY_ENFORCEMENT:END -->
-
+<!-- QUALITY_ENFORCEMENT:START -->
+# Quality Enforcement Rules
+
+**CRITICAL**: These rules are NON-NEGOTIABLE and MUST be followed without exception.
+
+## Absolute Prohibitions
+
+### Test Bypassing - STRICTLY FORBIDDEN
+- NEVER use .skip(), .only(), or .todo() to bypass failing tests
+- NEVER comment out failing tests
+- NEVER use @ts-ignore, @ts-expect-error, or similar to hide test errors
+- NEVER mock/stub functionality just to make tests pass without fixing root cause
+- FIX the actual problem causing test failures
+
+### Git Hook Bypassing - STRICTLY FORBIDDEN  
+- NEVER use --no-verify flag on git commit
+- NEVER use --no-verify flag on git push
+- NEVER disable or skip pre-commit hooks
+- NEVER disable or skip pre-push hooks
+- FIX the issues that hooks are detecting
+
+### Test Implementation - STRICTLY FORBIDDEN
+- NEVER create boilerplate tests that don't actually test behavior
+- NEVER write tests that always pass regardless of implementation
+- NEVER write tests without assertions
+- NEVER mock everything to avoid testing real behavior
+- WRITE meaningful tests that verify actual functionality
+
+### Problem Solving Approach - REQUIRED
+- DO NOT seek the simplest bypass or workaround
+- DO NOT be creative with shortcuts that compromise quality
+- DO solve problems properly following best practices
+- DO use proven, established solutions from decades of experience
+- DO fix root causes, not symptoms
+
+### Temporary Files and Scripts - STRICTLY FORBIDDEN
+- **NEVER** create temporary files in project root or any directory outside `/scripts`
+- **NEVER** create test files, log files, or debug files outside `/scripts`
+- **NEVER** leave temporary files after use - they MUST be deleted immediately
+- **ALWAYS** create all scripts inside `/scripts` directory
+- **ALWAYS** remove temporary files immediately after use (MANDATORY)
+- **ALWAYS** clean up test artifacts, log files, and debug files before committing
+- **ALWAYS** use `/scripts` directory for any temporary scripts or test files
+
+**Why This Matters:**
+LLM assistants often create temporary files for testing but forget to remove them, accumulating dozens of junk files that pollute the repository. All temporary work MUST be done in `/scripts` and cleaned up immediately.
+
+**Examples:**
+- ❌ Creating `test.js`, `debug.log`, `temp.json` in project root
+- ❌ Leaving test files after debugging
+- ❌ Creating scripts outside `/scripts` directory
+- ✅ Creating `/scripts/test-feature.js` and removing it after use
+- ✅ Using `/scripts` for all temporary work
+- ✅ Cleaning up all temporary files before committing
+
+## Enforcement
+
+These rules apply to ALL implementations:
+- Bug fixes
+- New features  
+- Refactoring
+- Documentation changes
+- Any code modifications
+
+**Violation = Implementation Rejected**
+
+<!-- QUALITY_ENFORCEMENT:END -->
+