diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..64083e778 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,16 @@ +# Contributing + +Please note we have a code of conduct, please follow it in all your interactions with the project. If you have any further questions please create an issue or ask in the Discord server. + +- Only fix/add the functionality in question OR address wide-spread whitespace/style issues, not both. +- Address a single concern in the least number of changed lines as possible. + +**Do not make a pull request to merge into stable unless it is a hotfix. Use the development branch instead.** + +## Pull Request Process + +1. Ensure any install or build dependencies are removed before the end of the layer when doing a + build. +2. Update the README.md and wiki with details of changes to the interface, this includes new environment + variables, exposed ports, useful file locations and container parameters. +3. Write with detail on your pull request description what you have committed, to make it easier for the collaborators to make a changelog.