Skip to content

Distributed Peer-to-Peer Web Search Engine and Intranet Search Appliance

Add contributor guidelines; closes #214

Erik Dominikusf04580ecfd4e
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 000000000..7bd186ed4
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,18 @@
+# YaCy contributor guidelines
+
+Thank you for contributing to YaCy!
+We appreciate all contributions, no matter how small.
+
+Please create a pull request.
+
+Some tips to make it more likely for your pull request to be accepted:
+
+- Don't make big changes without discussing it first.
+ - Don't make big refactorings without any new functionality.
+ - Don't remove functionality unless we discussed that somewhere.
+- Don't change whitespaces unnecessarily.
+ - Don't change line endings (LF/CRLF).
+ - Don't change formatting (spaces, tabs).
+- Don't commit code you don't understand.
+ - Don't commit code without testing its function (and a bit of debugging).
+- Don't put someone else's name in your copyright statement (don't put other people's name in the copyright statement if you add a new class; put your own name).