Workflow

Contribution process

Code projects are managed either with GitLab or Github, to which most of the following applies besides some differences in web interfaces.

• Move to the master branch:

git checkout master

• Synchronize the local branch with the remote:

git pull --rebase origin master

• Create a new feature branch:

git checkout -b <my_branch>

where should have the form 'prefix/description' with possible prefixes:

Prefix	Type of contribution
build	Modification to the build system
cleanup	Non-functional modification of the code (style, refactoring)
feature	Addition of a new function
fix	Bug fix
test	Modification to the test suite

and description should be a lower case text separated with underscores.

Example: fix/simplex3d_invalid_critere.

• Commit your changes with each of them self-contained and consisting of one identified task only. The commit message should be formatted as: ": "

Example: "ModeleOperationSurPatch: fix memory leaks".

• Make sure the test suite is successful after each commit.

• Synchronize the local branch with the remote if it has changed since the last pull:

git pull --rebase origin master

• Push your changes to the remote repository:

git push origin <my_branch>

• Open a merge request: go to "Repository > Branches" on the left menu then pick the branch you want to merge.