zhdev/oblak
1
0
Fork 0
Code Issues Pull requests Activity

Create CONTRIBUTING.md

Browse source
This commit is contained in:
Alexander Söderberg 2020-09-11 21:05:16 +02:00 • committed by GitHub
parent f2aeae334c
commit dacf0e58c7
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

13
CONTRIBUTING.md Normal file
View file

@ -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!