From d59f82d1427ffeaa6de6e6dd1982a0e9b1af8427 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?B=C3=A9r=C3=A9nice=20Batut?= Date: Tue, 5 Nov 2024 17:22:46 +0100 Subject: [PATCH] Update sources/README.md --- sources/README.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/sources/README.md b/sources/README.md index 2cb84a39..53b7bd16 100644 --- a/sources/README.md +++ b/sources/README.md @@ -204,12 +204,17 @@ $ python sources/bin/create_interactive_table.py \ ### Contributing -To contribute to the CoDex Source code fork the repository, create a branch and add your changes. Then make a -pull request to the **dev branch** of the CoDex repository. Upon review the maintainer will merge your pull request. +To contribute to the CoDex Source code: +1. fork the repository, +2. create a branch and add your changes +3. make a pull request to the **dev branch** of the CoDex repository. + +Upon review the maintainer will merge your pull request. Automatic tests will run on the dev branch. + When the tests succeed a maintainer will merge the dev branch into main. Feel free to ping the maintainers to speed up the process. -The reason we are not running the tests directly on the pull request branch is, that this does not allow to access the -GitHub secrets, that are required to run the tests. + +The reason we are not running the tests directly on the pull request branch is, that this does not allow to access the GitHub secrets, that are required to run the tests. ### Tools