From 5b4224b8f55b1125f0d13893606397fb6bfc7852 Mon Sep 17 00:00:00 2001 From: Nicolai Ort Date: Fri, 27 Nov 2020 21:45:29 +0000 Subject: [PATCH] Added our branch structure to the readme --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 0898503..077f888 100644 --- a/README.md +++ b/README.md @@ -44,9 +44,18 @@ docker-compose up --build - will be automatically recommended via ./vscode/extensions.json +## Branches +- main: Protected "release" branch +- dev: Current dev branch for merging the different features - only push for merges or minor changes! +- feature/xyz: Feature branches - `feature/issueid-title` +- bugfix/xyz: Branches for bugfixes - `bugfix/issueid-title` (no id for readme changes needed) + + ## File Structure - src/models/\* - database models (typeorm entities) - src/controllers/\* - routing-controllers - src/loaders/\* - loaders for the different init steps of the api server - src/routes/\* - express routes for everything we don't do via routing-controllers (shouldn't be much) +- src/middlewares/\* - express middlewares (mainly auth r/n) +- src/errors/* - our custom (http) errors