Files
metabuilder/docs/todo/core/0-kickstart.md
2025-12-27 04:19:24 +00:00

2.3 KiB
Raw Permalink Blame History

0 - Kickstart (Start Here)

Use this file when youre not sure what to do next, or you want a quick “make it green” loop before starting a larger task.

The Default Workflow

How These TODOs Work

  • Keep items small and actionable (one change set per checkbox when possible)
  • When you complete an item, mark it [x] and add a short reference (commit hash or PR)
  • If an item grows, split it into follow-ups (or a new numbered TODO file) and link it from ./README.md
  • Prefer including concrete file paths and commands in TODO items

Project TODO Scan (Code + Docs)

From docs/todo/:

  • Run python3 scan-project-todos.py
  • Review TODO_SCAN_REPORT.md for in-repo TODO/FIXME/HACK/XXX markers
  • Review TODO_STATUS.md for open vs done counts across this folder

15-Minute Local Sanity Check (Frontend)

Run from frontends/nextjs/:

From repo root: cd frontends/nextjs (or from docs/todo/: cd ../../frontends/nextjs)

  • npm ci (or npm install)
  • npm run typecheck
  • npm run lint (commit 04ba8e8)
  • npm run test:unit
  • npm run build

If CI/workflows are the goal, validate locally with npm run act:diagnose / npm run act (from frontends/nextjs/).

If Something Fails, Start Here

Done Criteria (For Most PRs)

  • The smallest relevant test suite is green (unit/E2E as appropriate)
  • From frontends/nextjs/: npm run lint and npm run typecheck are green
  • The TODO item(s) you addressed are marked [x] with a commit reference

If you get stuck, see ../../.github/prompts/EEK-STUCK.md.