From 3f102b15b6392e1f8d95070af417ff13ed42e08d Mon Sep 17 00:00:00 2001 From: Ricardo Arturo Cabral Mejia Date: Fri, 21 Oct 2022 17:59:08 -0400 Subject: [PATCH] docs: add CONTRIBUTING doc --- CONTRIBUTING.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..bae952c --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,16 @@ +# 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 keep the conversations civil, respectful and focus on the topic being discussed. + +## Pull Request Process + +1. Update the relevant documentation with details of changes to the interface, this includes new environment + variables, exposed ports, useful file locations and container parameters. +2. 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](http://semver.org/). +3. 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.