When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
Please note we have a code of conduct, please follow it in all your interactions with the project.
- Bugs and improvement requests can be reported on Github under issues
- Before opening an issue make sure there isn't already one opened with the same topic as yours.
- If an issue is not created yet, be sure to follow the issue templates provided and expose your issue in a clear way.
- Be sure you provide enough information so that the team can understand your problem and work on solving it
- If you want to help with documentation be sure you read the 'Why?' section of the README.md file first.
- Follow our vision for the project:
- Easy to understand
- Avoid using formulas and calculations
- Prefer simple examples demonstrating processes
- Avoid writing code for demonstrations, use open source tools
Check how to create a new challenge on our wiki
- There are multiple github actions running when you do a pull request. Only if they all pass your PR will be mergeable.
- If you want to create a PR just to check how you are doing, to make sure the actions pass, or to get some review, you can create the PR with the tag WIP. When you fill its good to go, remove the tag, so that the PR can be merged.
- If you need further tests add the label tests:needed and wait until somebody assists on it.
- If you added a label from the above 2 steps, the PR won't be mergeable, but that's ok, as it is supposed to.
- Ensure any install or build dependencies are removed before the end of the layer when doing a build.
- Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.