Skip to content

Latest commit

 

History

History
22 lines (15 loc) · 1.45 KB

CONTRIBUTING.md

File metadata and controls

22 lines (15 loc) · 1.45 KB
Raw

Contributing

When contributing to this repository, please first discuss the change you wish to make via an issue.

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 README.md and CHANGELOG.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 number in komoog/metadata.py and the README.md to the new version that this Pull Request would represent. The versioning scheme we use is SemVer.
  4. Please read the documentation part on testing. Make sure pytest is installed. Run make test to run all automated tests. Post the output as a comment in your Pull Request.
  5. You may merge the Pull Request in once you have the sign-off of one other developer, or if you do not have permission to do that, you may request the reviewer to merge it for you.

Attribution

This Contributing Statement is adapted from this template by @PurpleBooth.