Files
ukmesh/docs/contributing.md
T
Ben 21224a0525 Refactor backend, map, and worker boundaries
- split backend API into route/service/repository boundaries across stats, owner, and pathing\n- extract shared API bootstrap and helper modules\n- reduce MapLibreMap into smaller frontend map modules with extracted builders, config, popup UI, and types\n- continue worker modularization by extracting RF terrain/tile helpers alongside RF config and loss helpers\n- add repo-local architecture, DB lifecycle, link model, pathing, frontend map, and contributing docs\n\nThis is the verified refactor checkpoint: backend and frontend builds passed, worker syntax checks passed, affected containers were rebuilt, and /healthz is OK.
2026-03-20 17:45:47 +00:00

946 B

Contributing

Structural expectations

  • routes should stay thin
  • services own orchestration
  • repositories own SQL
  • worker RF math should stay separate from queue orchestration
  • frontend map builders should stay separate from MapLibreMap.tsx

Repository hygiene

Do not commit:

  • secrets
  • credentials
  • private database dumps
  • personal or personally identifiable information
  • operational traces containing sensitive infrastructure details
  • artifacts that could be used for abuse or malicious access

If in doubt, keep it out of Git and add it to .gitignore.

DB changes

  • schema creation goes in base schema or migrations
  • heavy historical fixes go in maintenance scripts, never startup

Testing expectations

Before finishing a refactor or behavior change:

  • build backend
  • build frontend
  • if worker code changed, run Python syntax checks
  • rebuild affected containers and check http://localhost:3000/healthz