From 307b35a5bfce9337de7e1a4b6583946b4bf4a4fe Mon Sep 17 00:00:00 2001
From: mrigal <matthieu@orderbird.com>
Date: Thu, 30 Apr 2015 14:52:08 +0200
Subject: [PATCH] some more update, mainly docs

---
 CONTRIBUTING.rst | 10 +++++++++-
 README.rst       |  6 ++++--
 docs/django.rst  |  2 +-
 3 files changed, 14 insertions(+), 4 deletions(-)

diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
index c935d5a3..c7f581a1 100644
--- a/CONTRIBUTING.rst
+++ b/CONTRIBUTING.rst
@@ -29,7 +29,10 @@ Style Guide
 -----------
 
 MongoEngine aims to follow `PEP8 <http://www.python.org/dev/peps/pep-0008/>`_
-including 4 space indents and 79 character line limits.
+including 4 space indents. When possible we try to stick to 79 character line limits.
+However, screens got bigger and an ORM has a strong focus on readability and
+if it can help, we accept 119 as maximum line length, in a similar way as
+`django does <https://docs.djangoproject.com/en/dev/internals/contributing/writing-code/coding-style/#python-style>`_
 
 Testing
 -------
@@ -38,6 +41,10 @@ All tests are run on `Travis <http://travis-ci.org/MongoEngine/mongoengine>`_
 and any pull requests are automatically tested by Travis. Any pull requests
 without tests will take longer to be integrated and might be refused.
 
+You may also submit a simple failing test as a PullRequest if you don't know
+how to fix it, it will be easier for other peopl to work on it and it may get
+fixed faster.
+
 General Guidelines
 ------------------
 
@@ -48,6 +55,7 @@ General Guidelines
   from the cmd line to run the test suite).
 - Ensure tests pass on every Python and PyMongo versions.
   You can test on these versions locally by executing ``tox``
+- Add enhancements or problematic bug fixes to docs/changelog.rst
 - Add yourself to AUTHORS :)
 
 Documentation
diff --git a/README.rst b/README.rst
index f2829cd3..f4c92d5f 100644
--- a/README.rst
+++ b/README.rst
@@ -26,7 +26,9 @@ a `tutorial <http://readthedocs.org/docs/mongoengine-odm/en/latest/tutorial.html
 
 Installation
 ============
-If you have `setuptools <http://peak.telecommunity.com/DevCenter/setuptools>`_
+We recommend the use of `virtualenv <https://virtualenv.pypa.io/>`_ and of
+`pip <https://pip.pypa.io/>`_. You can then use ``pip install -U mongoengine``.
+You may also have `setuptools <http://peak.telecommunity.com/DevCenter/setuptools>`_ and thus
 you can use ``easy_install -U mongoengine``. Otherwise, you can download the
 source from `GitHub <http://github.com/MongoEngine/mongoengine>`_ and run ``python
 setup.py install``.
@@ -114,7 +116,7 @@ Also use the -s argument if you want to print out whatever or access pdb while t
 
 .. code-block:: shell
 
-    $ python setup.py nosetests --tests tests/test_django.py:QuerySetTest.test_get_document_or_404 -s
+    $ python setup.py nosetests --tests tests/fields/fields.py:FieldTest.test_cls_field -s
 
 Community
 =========
diff --git a/docs/django.rst b/docs/django.rst
index 6982fe64..b8a52165 100644
--- a/docs/django.rst
+++ b/docs/django.rst
@@ -15,5 +15,5 @@ The MongoEngine team is looking for help contributing and maintaining a new
 Django extension for MongoEngine! If you have Django experience and would like
 to help contribute to the project, please get in touch on the 
 `mailing list <http://groups.google.com/group/mongoengine-users>`_ or by 
-simpily contributing on 
+simply contributing on
 `GitHub <https://github.com/MongoEngine/django-mongoengine>`_.