Skip to content

Latest commit

 

History

History
20 lines (16 loc) · 1.55 KB

CONTRIBUTING.md

File metadata and controls

20 lines (16 loc) · 1.55 KB

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, please follow it in all your interactions with the project.

Pull Request Process

  1. Fork the project. In case you have permissions in the repo, avoid creating branches, this pollutes the environment.
  2. Ensure any install or build dependencies are removed before the end of the layer when doing a build.
  3. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
  4. 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 Semantic Versioning.
  5. 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.
  6. Commit messages must be clear and follow the Semantic commit format
  7. Add your self in the contributor list by commenting in PR the following line: @all-contributors please add <username> for <contributions>, use as reference the emoji table to know what contribution types use. More info here