This repository has been archived by the owner on Feb 26, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
Development Guidelines
Tim Niederer edited this page Feb 12, 2021
·
4 revisions
This is a mono repository containing applications written in three different languages. Nevertheless, some general coding guidelines apply:
- The code should be documented sufficiently
- Warnings of the IDEs (JetBrains Products or XCode) have to be resolved (if possible)
- Every piece of code should match the result of the auto-formatting patterns
The main branch only holds working versions of the project. When implementing a new feature or fixing a bug you start with a branch based on the main branch.
The name of the branch should match the following pattern:
<type>/<issue-name-in-kebab-case>
- type: feature or bug
- name: a short version of the name of the feature/bug that you are working on
<type>(<scope>): <message>
<body>
- type: feat, fix, style, refactor, ... (the types are documented here)
- scope: e.g. app or server (just the package you are working on) or "*" for general changes
- message: a short description of the changes
- body: an optional longer description on complexer commits