Skip to content

Latest commit

 

History

History
26 lines (19 loc) · 1.39 KB

CONTRIBUTING.md

File metadata and controls

26 lines (19 loc) · 1.39 KB
Raw

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.

Branching Strategy

We use a simple branching strategy. The main branch is the production branch, and the dev branch is the development branch. All the development goes on in the dev branch. If you're contributing, please create a new branch off dev.

Pull Request Process

  1. Ensure any installation or build dependencies are removed before the end of the layer when doing a build.
  2. Update the readme.prp.md or Wiki 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 prp file 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.

Remember to always create a new branch for your work and open a pull request against the dev branch when you're ready.