From 56b72275aca57b227c775c4a61e91fd03471f987 Mon Sep 17 00:00:00 2001 From: Nicolai Ort Date: Tue, 2 Feb 2021 14:36:00 +0100 Subject: [PATCH] Added editor and stageing infos to the README ref #6 --- README.md | 25 ++++++++++++++++++++++++- 1 file changed, 24 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8663bdf..be8f066 100644 --- a/README.md +++ b/README.md @@ -28,4 +28,27 @@ The document generation server responsible for creating pdfs for sponsoring cont | Name | Type | Default | Description | - | - | - | - | APP_PORT | Number | 4010 | The port the backend server listens on. Is optional. -| NODE_ENV | String | dev | The apps env - influences debug info. \ No newline at end of file +| NODE_ENV | String | dev | The apps env - influences debug info. + +## Recommended Editor + +[Visual Studio Code](https://code.visualstudio.com/) + +### Recommended Extensions + +* will be automatically recommended via ./vscode/extensions.json + +## Staging +### Branches & Tags +* vX.Y.Z: Release tags created from the main branch + * The version numbers follow the semver standard + * A new release tag automaticly triggers the release ci pipeline +* main: Protected "release" branch + * The latest tag of the docker image get's build from this + * New releases get created as tags from this +* dev: Current dev branch for merging the different feature branches and bugfixes + * The dev tag of the docker image get's build from this + * Only push minor changes to this branch! + * To merge a feature branch into this please create a pull request +* feature/xyz: Feature branches - nameing scheme: `feature/issueid-title` +* bugfix/xyz: Branches for bugfixes - nameing scheme:`bugfix/issueid-title` \ No newline at end of file