Skip to content

Latest commit

 

History

History
19 lines (12 loc) · 1.54 KB

CONTRIBUTING.md

File metadata and controls

19 lines (12 loc) · 1.54 KB
Raw

How to Contribute

We'd love to accept your patches and contributions to this project. There are just a few small guidelines you need to follow.

When contributing to this repository, please first discuss that new features be discussed via issue before making a change.

Please report any bugs to the issues page, due to the fact this project is done in free time, it may take a while to process the issues, but security vulnerabilities will have precedence over feature requests.

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

Pull Request Process

All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose. Consult GitHub Help for more information on using pull requests.

  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 (if applicable).
  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. You may merge the Pull Request in once you have the sign-off of other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.