Contributing

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, which you should follow in all your interactions with the project.

Pull Request Process

  1. Ensure any install or build dependencies are removed before the end of the layer when building.

  2. If applicable, update the README with details of changes to the interface, including new environment variables, useful file locations and container parameters where appropriate. There should already be a section for each of the above cases. Do not add extraneous new sections without another issue.

  3. If this PR bumps the version, as previously discussed with an owner or maintainer, increase the version number in the relevant locations. Only maintainers are allowed to increment the minor version. The versioning scheme we use is SemVer, but we currently only have major, minor and patch parts for simplicity.

  4. Once you have the sign-off of one other developer, you may either merge the PR yourself if you have permission, or ask the reviewer to do so on your behalf otherwise.

Notes

Do not abuse your write access to the repository to, for example, create a fake or unprompted release. In this case, your write access will be revoked.