Commit bf07fe84 authored by Alexandre Delanoë's avatar Alexandre Delanoë

[DOC] Gitlab collaboration tips.

parent 3cff08f6
...@@ -50,10 +50,26 @@ Git is the main Concurrent Version system used by the project. ...@@ -50,10 +50,26 @@ Git is the main Concurrent Version system used by the project.
#### Git branches #### Git branches
Main branches are: Main branches are:
* `master/prod` : stable version used by end users * `master` : stable and prod version used by end users
* `testing` : candidate version for stable, tested by end users * `testing` : candidate version for stable, tested by end users
* `dev` : unstable version for developers only * `dev` : unstable version for developers only
#### Adding a new feature / fixing an issue
1. You should have an open issue in gitlab with number ~#XXX~.
2. ~git checkout -b issue-XXX-issue-short-description~
3. work... ~git commit~ many times
4. Optionally you can clean up your git log history with ~git rebase -i master~
5. Test locally ~./build.sh (TODO && ./build/run-tests.sh)
6. ~git push -u~ will push and create the branch on gitlab
7. Open a PR. In the PR reference the issue by writing (~Close #XXX~ or
~Connects to #XXX~).
8. Make changes according to PR feedbacks
9. Either use the =Squash & Merge button= in github or manually rebase. Please
take the time to write a good commit message. For example be inspired by
https://chris.beams.io/posts/git-commit/
##### Git Tips ##### Git Tips
* fix the conflicts on your own branch before asking for [PR] * fix the conflicts on your own branch before asking for [PR]
* `git rebase dev` daily to make sure you do not diverge * `git rebase dev` daily to make sure you do not diverge
......
Markdown is supported
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