Create CONTRIBUTING.md

bytemakers · Aug 6, 2022 · e7af05b · e7af05b
1 parent 2319660
commit e7af05b
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,12 @@
+# 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](CODE_OF_CONDUCT.md), 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 `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 PR would represent.
+4. You may merge the PR 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 merge it for you.