Add contributing guidelines

bwaldvogel · Jan 9, 2019 · e0efea0 · e0efea0
1 parent 58d1cdf
commit e0efea0
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,15 @@
+## Contributing ##
+
+We are happy to receive pull-requests if you want to contribute code to the project.
+Please use the code style settings that you can find in the [code-style directory](code-style/).
+
+Issues labeled [help wanted][issues-help-wanted] or [good first issue][issues-good-first-issue]
+can be good first contributions.
+
+If you want to thank the author for this library or want to support the maintenance work,
+we are happy to receive a donation.
+
+[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.me/BenediktWaldvogel)
+
+[issues-help-wanted]: https://github.com/bwaldvogel/mongo-java-server/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22
+[issues-good-first-issue]: https://github.com/bwaldvogel/mongo-java-server/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22
diff --git a/README.md b/README.md
@@ -2,6 +2,7 @@
 [![Maven Central](https://maven-badges.herokuapp.com/maven-central/de.bwaldvogel/mongo-java-server/badge.svg)](http://maven-badges.herokuapp.com/maven-central/de.bwaldvogel/mongo-java-server)
 [![Coverage Status](https://coveralls.io/repos/github/bwaldvogel/mongo-java-server/badge.svg?branch=master)](https://coveralls.io/github/bwaldvogel/mongo-java-server?branch=master)
 [![BSD 3-Clause License](https://img.shields.io/github/license/bwaldvogel/mongo-java-server.svg)](https://opensource.org/licenses/BSD-3-Clause)
+[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.me/BenediktWaldvogel)
 
 # MongoDB Java Server #
 
@@ -181,6 +182,14 @@ public class Application {
 }
 ```
 
+## Contributing ##
+
+Please read the [contributing guidelines](CONTRIBUTING.md) if you want to contribute code to the project.
+
+If you want to thank the author for this library or want to support the maintenance work, we are happy to receive a donation.
+
+[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.me/BenediktWaldvogel)
+
 ## Ideas for other backends ##
 
 ### Faulty backend ###