Skip to content

[Documentation] - Update how to contribute

Why update the contribution guideline?

During our firsts contributions with @alexiaognard, we followed the guideline from the handbook and the how to contribute pages. However, we noticed some slight differences with reality. In order to improve the quality of life and development of future contributors, we should update the contribution guideline to be the closest to real practices.

What should we change?

Here is a list of actions to make the contribution guideline better:

  • To add an explanation on how to get the link of a job documentation generated by MkDocs. Also specified that every contributor has to link the generated doc in the comment section of the MR.
  • To specify that the image used in job should be official in the docker hub. If it isn't, it should be a reliable image maintained frequently.
  • To add a variable for the image version. This has two main benefits: when a new version of the image is out we don't have to update our jobs in the minutes, our users can update it themselves. And they can run the job on an older version to check compatibility of their code.

If you find some problems we should address regarding the contribution guideline, you can add them to this list

How should we implement those changes?

We can update:

  • The [new job] issue template
  • The handbook
  • The how to contribute page