From dacf0e58c75d826fc4afced3dbe6bff2cbf8bfda Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alexander=20S=C3=B6derberg?= Date: Fri, 11 Sep 2020 21:05:16 +0200 Subject: [PATCH] Create CONTRIBUTING.md --- CONTRIBUTING.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..b2ac508c --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,13 @@ +# Contributing to cloud + +Before contributing to the library, you are highly encouraged to join our Discord (linked in the README) to discuss the changes. +For your code to be approved, we ask of you the following: +- Attempt to follow the project code style. In the repository there is an `.editorconfig` file which has been setup to configure IntelliJ IDEA to use our code style. +If you use another editor, you might have to do some manual formatting. Small deviations are not necessarily a big deal, but do your best. +- Make sure that your code is tested & fully functional. If possible, create a test file as well. +- Feel free to add yourself to the copyright notice in the file license header, for the files that you have added and/or edited. +Also attach to each file a license header, using the text in the LICENSE file. +- Try to limit the scope of your PR. It is better to create two PRs, than to include irrelevant changes in one. +- Please document your public methods and add nullability annotations to all method return types, and method parameters. + +We highly appreciate all contributions to the project and we look forward to seeing yours!