added CONTRIBUTING.md

NicolasHug · Dec 28, 2016 · 0d6c143 · 0d6c143
1 parent 4e160a7
commit 0d6c143
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 2 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,13 @@
+Contributing to Surprise
+========================
+
+Pull requests are always welcome! Before submitting a new pull request, please
+make sure that:
+
+* your code is clean, well commented and if it's a new feature/algorithm, that
+  it's also well documented.
+* your code passes the tests (use [pytest](http://doc.pytest.org/en/latest/)),
+  plus the ones that you wrote ;)
+* your code is [PEP 8](https://www.python.org/dev/peps/pep-0008/) complient.
+  You can use [flake8](http://flake8.pycqa.org/en/latest/index.html) for
+  checking.
diff --git a/README.md b/README.md
@@ -199,4 +199,6 @@ ideas are:
 - Bayesian PMF
 - RBM for CF
 
-Please feel free to contribute and send pull requests!
+Please feel free to contribute (see
+[guidelines](https://github.com/NicolasHug/Surprise/blob/master/CONTRIBUTING.md))
+and send pull requests!
diff --git a/TODO.md b/TODO.md
@@ -4,7 +4,6 @@ TODO
 * Check out the yelp dataset
 * See if we could compute similarity on the fly (see issue #3)
 * configure entrypoints to use surprise directly from command line
-* make a 'contribute' file
 
 Maybe, Maybe not
 ----------------