WORKFLOW.md

WORKFLOW.md

WORKFLOW - READ BEFORE EVERY CODE CHANGE

🛑 STOP: Before Modifying ANY Code

Two-tier documentation system - Read BOTH types:

1. Read folder-level docs (detailed architecture)
2. Read function-level docs (concise: 1-3 sentences)

Examples:

• Modifying internal/api/router.go?

  1. Read docs/internal/api-docs.md (folder-level: detailed)
  2. Read docs/internal/api/router.md (function-level: concise)

• Adding internal/api/handlers/user.go?

  1. Read docs/internal/api-docs.md + docs/internal/api/handlers-docs.md (folder-level)
  2. Read existing handler docs in docs/internal/api/handlers/ (function-level)

🛑 STOP: After Writing ANY Code

Run this ONE command (all must pass):

go build ./... && go test ./... && go test -race ./... && golangci-lint run ./...

If ANY command fails: FIX BEFORE PROCEEDING. NO EXCEPTIONS.

🛑 STOP: Before Committing

1. All commands above passed? ✅
2. Updated function-level docs in docs/**/*.md? (concise: 1-3 sentences) ✅
3. Updated folder-level docs if architecture changed? (detailed) ✅
4. All code files under 250 lines? ✅

Quick Reference

Two-Tier Documentation:

Folder-Level (Detailed):

• docs/internal/api-docs.md → Architecture for internal/api/
• docs/internal/api/handlers-docs.md → Architecture for internal/api/handlers/

Function-Level (Concise: 1-3 sentences):

• cmd/api/main.go → docs/cmd/api/main.md
• internal/api/router.go → docs/internal/api/router.md
• internal/api/handlers/health.go → docs/internal/api/handlers/health.md

250 Line Limit:

• If file exceeds 250 lines, split immediately
• Update both doc types to reflect new structure

No Exceptions. No Shortcuts.