diff --git a/contributing.md b/contributing.md new file mode 100644 index 0000000..59030f7 --- /dev/null +++ b/contributing.md @@ -0,0 +1,5 @@ +TO CONTRIBUTE TO THIS PROJECT PLEASE FOLLOW CERTAIN RULES: +1. Don't modify the master branch. Do everything in a separate branch +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. Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent. +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.