Skip to content

Master Development Guide

Purpose

This guide connects all project development guides into one shared workflow. It is the entry point for every developer joining the UMTAS project.

Core Philosophy: TDD First

Our guide system strongly emphasizes Test-Driven Development (TDD) to keep development correct, consistent, and easy to refactor.

The Golden Rule

Write the test before you write the code.

Guide Map

Use the following specialized guides based on your current task:

Guide Primary Focus
Backend Dev NestJS APIs, DrizzleORM, Python Solver, Swagger.
Frontend Dev Next.js UI, Shadcn/UI, Radix state.
Server & Infra Docker, Traefik, MinIO, Monitoring (PLG).
Unit Testing Isolated logic, utilities, component behaviour.
Integration Cross-service communication, database flows.
Local CI/CD Running act and pre-push checks.
Git Strategy Branching, PRs, and naming conventions.

For new team members, we recommend the following onboarding path:

  1. Master Development Guide (You are here)
  2. Git Strategy Guide (Workflow foundation)
  3. Local CI/CD Guide (Quality foundation)
  4. Domain-Specific Guide (Backend, Frontend, or Server)
  5. Testing Guides (Quality assurance)

Which Guide to Use?

Quick Routing Model

Shared Standards

These expectations apply to all developers, regardless of their role:

Standard Checklist

  • [ ] Work in a dedicated feature branch.
  • [ ] PRs must target dev.
  • [ ] PRs must be clear and easy to review.
  • [ ] Link related issues (Closes #...).
  • [ ] CI must pass before merge.
  • [ ] Conflicts must be resolved before review.

Definition of Done

Project-Level Readiness
  • The correct guide workflow has been followed.
  • The feature is implemented and verified.
  • Required tests have been completed and passed.
  • Local act checks have been run.
  • The PR is complete, reviewed, and approved.
  • CI passes successfully on the remote.