Skip to content

Contributing

Please contribute by creating pull-requests and filing issues on our GitHub repository.

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.

Pull Request Process

  1. Ensure any install or build dependencies are removed before the end of the layer when doing a build.
  2. Update the documentation under docs/ with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and code examples.
  3. Increase the version numbers in the project's root CMakeLists.txt to the new version that this Pull Request would represent. The versioning scheme we use is SemVer.
  4. 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.