Skip to content

Latest commit

 

History

History
35 lines (24 loc) · 1.29 KB

CONTRIBUTING.md

File metadata and controls

35 lines (24 loc) · 1.29 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.

Issue template:

# Name (issue type with meaningful name)
[FEATURE/BUG/QUESTION] xyz

# Description
_ Please describe your issue here _

# Why
_ Please explain why this issue is important to the project _

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 README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
  3. Rebase your branch so that you only have one commit left in the repository. This helps us keep a clear git history, allowing us to clearly see what has been done very quickly.
  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.

Failure to go by these 4 simple rules will result in your pull request being rejected.