[FEATURE] Docs: Explain branches

[jirafeau_project.git] / CONTRIBUTING.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 8c6752ef422bdc0289090d050675cb2e453ab188..641fb44c18403ace6de893be36eee2206847ecec 100644 (file)
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -61,8 +61,16 @@ Translation may be add via [Jirafeau's Weblate](https://hosted.weblate.org/proje
 
 The whole project is not clean about that yet, feel free to fix :)
 
+## Branches
+
+* ```master``` = latest release, e.g. 2.0.1
+* ```next-release``` = development branch - all new features are merged into this branch until the next version is released. So use this branch as base while developing new features or bugfixes.
+* ```test``` = sandbox branch to test new features or merge requests, or run integration tests. The content of this branch may change at any time.
+
 ## Merge Requests
 
 Please create one branch for each feature and send one merge request for each branch. 
 
 Dont squash several changes or commits into one merge request as this is hard to review.
+
+Please use ```next-release``` as base branch and send your merge request to this branch (not ```master```).