How to contribute

Author

Marie-Pierre Etienne

One chapter corresponds at least to one branch

  • Create a specific branch for your chapter named an_explicit_name_for_the_branch and switch on this branch

git checkout -b an_explicit_name_for_the_branch

In the development of the project, you might find necessary to have several branches per chapter.

  • Create a quarto file for the chapter chapter0.qmd in your branch

git add chapter0.qmd

git commit -m "first commit in the chapter branch"

  • Push everything on the remote repo on Github

For the first push after the branch creation, you have to specify the name of the branch on the remote repo and you can use git push --set-upstream origin an_explicit_name_for_the_branch or

For the push to come after the first one, you will simply push by

git push

Once you are quite happy with your production, you will be willing to integrate your production on the main branch. A good practice is to ask the permission to push on the main branch, which is named a pull request (PR).

  • Ask for a PR on Github

  • If needed, specify in the PR message the package you need and mention MarieEtienne as reviewer of the PR.

A mock rendering of the qmd file will start when you request a PR using the Github Action mechanism (called runner on gitlab). If the action passes (green signal), you can go to the next step. If not, you will have to fix the issue (again you can ask assistance if you don’t understand the error).

  • Once the PR is checked, mention one of your colleage as reviewer.

As a reviewer

Your role is essential as you are responsible for the quality of the submission you were assigned to. Read carefully the production and ask for correction/clarification if needed. One you are happy with the correction you can accept the PR.