Skip to content

KICKOFF.md

Latest commit

 

History

History
136 lines (90 loc) · 2.97 KB

KICKOFF.md

File metadata and controls

136 lines (90 loc) · 2.97 KB

Kickoff — Session Startup Script

Run through this checklist at the start of every working session.

1. Check Current State

# Verify clean working tree
git status

# Pull latest changes
git pull origin main

If there are uncommitted changes:

  • Stash them with git stash push -m "WIP: description" if you want to save them temporarily
  • Or ask the user if they should be committed first

1.5 Ensure Local Environment is Ready

Before starting work, verify your local environment is set up:

# Check Docker is running
docker compose ps

# If not running, start the full stack:
docker compose up -d

# Ensure migrations and seed data are current:
make migrate
make seed

See doc/ref/local_dev.md for full local development setup.

2. Inspect Progress

  1. Read doc/progress/SUMMARY.md to see what's completed and in-progress.
  2. Read doc/spec/ROADMAP.md to identify the next unstarted card.
  3. Determine which card to work on based on dependencies.

3. Assess & Plan

Before writing code, evaluate:

Factor Questions
Complexity Is this a simple implementation or a complex feature?
Risk Does it touch the database schema or core APIs?
Testing Will new tests be required?
Scope Can this be done in one session, or should it be split?

4. Branching Decision

Prompt the user with your assessment:

"The next card is [Card XX: Title]. It's [simple/complex] — involves [scope summary]. Should I create a feature branch (feature/XX-description) to trigger the preview workflow, or work directly on main?"

Branching Guidelines

  • Create a branch if:

    • The work involves multiple files or significant changes
    • You want the full CI/CD pipeline to run
    • It's a feature that should be reviewed via PR

  • Work on main if:

    • Quick fixes or single-file changes
    • Documentation-only updates
    • The user explicitly approves

5. Launch Work

  1. Read the relevant specification in doc/ref/ to refresh context.
  2. Begin implementation.
  3. Follow the acceptance criteria in the spec.

6. Verification (End of Session)

  1. Run lint/typecheck:

    # Python
ruff check .
mypy .

# TypeScript/Frontend
npm run lint
npm run typecheck

  2. Run tests:

    make test-unit    # or relevant test command

  3. Verify acceptance criteria from the card spec.

7. Close & Update Progress

  1. Commit all changes with a descriptive message.
  2. Update doc/progress/SUMMARY.md:
    • Add a line for this work item with short description and blockers/follow-ups
  3. Clearly relay status to user and ask if they want you to push changes

Example Flow

> git status
On branch main. Working tree clean.

> cat doc/progress/SUMMARY.md

# Progress Summary

This document is used to track progress.

2025-03-12 Initial documentation restructure (PRD, Roadmap, Reference library) completed, no issues