Commit bf81d52b authored by David Trattnig's avatar David Trattnig
Browse files

Docs: Add details on git

parent fc6d229a
......@@ -10,10 +10,10 @@ Here you find an overview of our conventions on coding and version control.
### git
* We use [GitHub Flow](https://docs.github.com/en/get-started/quickstart/github-flow)
* Release branch is `main`, pre-production branch is `staging`
* Avoid crunching commits and rebasing; set `git config pull.rebase false` to use *recursive* as your merge strategy
* Keep the `main` branch stable, as releases are derived from it
* Avoid crunching commits and rebasing; set `git config pull.rebase false` to use *recursive* as your default merge strategy
* We use [*the seven rules of a great Git commit message*](https://cbea.ms/git-commit/#seven-rules), and optionally [*conventional commits*](https://www.conventionalcommits.org/)
* Mention related ticket ID where applicable, like `#123`
* Mention related ticket IDs where applicable, like `#123` or `player#123` when cross-referencing between repositories
* Use [atomic commits](https://www.freshconsulting.com/insights/blog/atomic-commits/)
### Python
......@@ -65,7 +65,7 @@ After that, you need to configure the projects in following order:
3. [Tank](https://gitlab.servus.at/aura/tank) - Upload, pre-processing and storage of the audio files.
4. ...
**Playout Projects**
**Play-out Projects**
1. [Engine Core](https://gitlab.servus.at/aura/engine) - Playout-engine to deliver the actual radio to the audience.
2. [Engine API](https://gitlab.servus.at/aura/engine) - API Server to provide playlogs and information for the studio clock.
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment