Skip to content

Latest commit

 

History

History
23 lines (15 loc) · 1.19 KB

CONTRIBUTING.md

File metadata and controls

23 lines (15 loc) · 1.19 KB

Contributing

Firstly, thanks for taking time to contribute to this reporitory! People like you power this open source community.

Please note we have a code of conduct, please follow it in all your interactions with the project.

How to file a bug report or feature request?

  1. This repository has issue, feature request and pull request templates which would autofill when you raise a bug, request for a new feature or when you raise a PR. Do your best to fill out the template completely.

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 README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
  3. 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.
  4. Pull requests will be approved by one of the owners of this repository.

How to set up your environment and run tests?

  1. Building and installation instructions are present in README.md file.