Git Workflow

The recommended Git workflow is the following:

1. Create an issue in GitLab:

   • Explain what the task is about

   • Note the issue_number

2. Create a branch in your local copy. The naming convention for the branch is the following:

   • name start with the issue_number

   • group of words separated by hyphen. A short description of what the task is about

   • example: 101-develop-module-ftdi

3. Develop your python code:

   • follow coding style rules

   • include unitary test

   • test, test, …

   • push it regularly to GitLab

4. Once ready, apply coding style tools

5. Push to GitLab and launch a merge request:

   • Fill the description with what has been done

   • Check that the description ends with:

        Close #issue_number
     

6. A merge request trigger continuous integration steps to check and test the pushed code. Therefore, have a look to CI/CD > pipelines and CI/CD > Jobs. It a job failed, fix the issue and push modification in GitLab. Pipelines will be relaunched automatically.

7. Once all checks are OK, one of your colleagues will have a look to the proposed modification and will accept them.

8. Do not forget to delete the branch in GitLab. Can be done automatically at the end of the merge request (recommended way)