Skip to content

Commit

Permalink
Update sources/README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
bebatut authored and paulzierep committed Nov 6, 2024
1 parent 458d738 commit d59f82d
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions sources/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit d59f82d

Please sign in to comment.