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.
A good way to contribute is to implement one of the features or solve one of the bugs listed in the roadmap (you can find it here). The roadmap is not exhaustive, so feel free to suggest new features.
If you find a bug, please open an issue on GitHub. If you can, please provide a minimal reproducible example.
If you want to add a new feature, please open an issue on GitHub to discuss it before starting to code.
If you want to contribute to the project, please fork the repository and create a pull request. Please follow the Pull Request Process below.
Please read the code of conduct before contributing to the project.
This project is under MIT license. Please read the license for more information.
If you want to contribute in another way, please contact me at [email protected].
- 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.
- Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent. The versioning scheme we use is SemVer.
- You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.