Engineering Guidelines¶
Conventions and recipes for working in the codebase: code style, adding a feature, API design, TypeORM/data, testing, and the git/contribution workflow.
- Engineering Conventions & Code Style — This document is the canonical reference for how code is structured and written in the
- Recipe — Adding a New Feature — This is the canonical, copy-pasteable recipe for adding a new vertical feature to the
- API Design & Error Conventions — This guideline is the canonical reference for how HTTP APIs are shaped in the
- Data & TypeORM Guidelines — This is the canonical engineering guideline for working with the persistence layer of the
- Testing Strategy — This guideline documents how automated testing actually works in mr-mentor-backend today: the Bun test runner, the (parallel) ts-jest config, where tests live, the unit-vs-integration split, fixtures and test seeding, and — honestly —…
- Git Workflow & Contribution Guide — This guide is the canonical reference for how code moves from a developer's laptop into production for the mr-mentor-backend repository (MAS-Mr-Mentor/mr-mentor-backend). It documents branch naming, commit-message conventions, the dated…