Skip to content

Latest commit

 

History

History
43 lines (34 loc) · 2.54 KB

File metadata and controls

43 lines (34 loc) · 2.54 KB

Claude Docs (Index)

This repository maintains a six-page Claude documentation set. Each category must stay within one page.

  • Architecture → CLAUDE/01-architecture.md
  • Rules → CLAUDE/02-rules.md - Hard rules unbreakable. Cap to 25.
  • Mindset → CLAUDE/03-mindset.md - How to approach problems features, chores, bugs, etc.
  • Philosophy → CLAUDE/04-philosophy.md - Includes things like tdd etc.
  • Mental Model → CLAUDE/05-mental-model.md - Rule of thumbs to remember for the founder.
  • Flowchart → CLAUDE/06-flowchart.md - How data flowing in the application, high level.

Worktree Management


JIRA – Bug/Feature/Debt Tracking

  • Overview: docs/jira/README.md
  • Workflow: docs/jira/CLAUDE.md
  • Categories:
    • Bugs: docs/jira/bug-logs/ – Broken functionality, test failures, regressions
    • Features: docs/jira/feature-requests/ – New capabilities, enhancements, architectural additions
    • Technical Debt: docs/jira/tech-debt/ – Deferred work, architectural shortcuts, refactoring
  • Milestones: docs/jira/milestones/ – Ordered sequences of bugs/features/debt per milestone

Recent Changes (2025-10-21)

  • M5.5 Phase 1 Complete: All integration tests passing (6/6). Fixed PrismaClient DI, per-test DB clients, module state isolation, deterministic execution.
  • Test Architecture: Comprehensive patterns documented in packages/features/agents-run/tests/claude.md.
  • DI & Singleton Rules: Added to CLAUDE/02-rules.md - no global singletons in tests, explicit container passing, defensive concurrent updates.
  • TDD Best Practices: Expanded in CLAUDE/04-philosophy.md - test isolation, deterministic execution, database management, anti-patterns.
  • oRPC Native SSE: Migrated from fallback HTTP/SSE routes to oRPC's Event Iterator for streaming (2025-10-18).
  • JIRA Structure: Consolidated bug-logs, feature-requests, and tech-debt into docs/jira/ with workflow documentation.
  • M5 Status: Phase 1 (Ports-first Infra Seam) complete in PR #66. Phase 3 (Awilix DI) complete in M5.5.

Update policy (enforced):

  • Every push must include a commit trailer: Claude-Update: yes or Claude-Update: no.
  • If yes, the most recent commit must modify CLAUDE.md or files under CLAUDE/.
  • The combined Claude docs cannot exceed six pages (one category per page).