Skip to content

Commit 307b35a

Browse files
committed
some more update, mainly docs
1 parent 217c972 commit 307b35a

File tree

3 files changed

+14
-4
lines changed

3 files changed

+14
-4
lines changed

CONTRIBUTING.rst

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,10 @@ Style Guide
2929
-----------
3030

3131
MongoEngine aims to follow `PEP8 <http://www.python.org/dev/peps/pep-0008/>`_
32-
including 4 space indents and 79 character line limits.
32+
including 4 space indents. When possible we try to stick to 79 character line limits.
33+
However, screens got bigger and an ORM has a strong focus on readability and
34+
if it can help, we accept 119 as maximum line length, in a similar way as
35+
`django does <https://docs.djangoproject.com/en/dev/internals/contributing/writing-code/coding-style/#python-style>`_
3336

3437
Testing
3538
-------
@@ -38,6 +41,10 @@ All tests are run on `Travis <http://travis-ci.org/MongoEngine/mongoengine>`_
3841
and any pull requests are automatically tested by Travis. Any pull requests
3942
without tests will take longer to be integrated and might be refused.
4043

44+
You may also submit a simple failing test as a PullRequest if you don't know
45+
how to fix it, it will be easier for other peopl to work on it and it may get
46+
fixed faster.
47+
4148
General Guidelines
4249
------------------
4350

@@ -48,6 +55,7 @@ General Guidelines
4855
from the cmd line to run the test suite).
4956
- Ensure tests pass on every Python and PyMongo versions.
5057
You can test on these versions locally by executing ``tox``
58+
- Add enhancements or problematic bug fixes to docs/changelog.rst
5159
- Add yourself to AUTHORS :)
5260

5361
Documentation

README.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,9 @@ a `tutorial <http://readthedocs.org/docs/mongoengine-odm/en/latest/tutorial.html
2626

2727
Installation
2828
============
29-
If you have `setuptools <http://peak.telecommunity.com/DevCenter/setuptools>`_
29+
We recommend the use of `virtualenv <https://virtualenv.pypa.io/>`_ and of
30+
`pip <https://pip.pypa.io/>`_. You can then use ``pip install -U mongoengine``.
31+
You may also have `setuptools <http://peak.telecommunity.com/DevCenter/setuptools>`_ and thus
3032
you can use ``easy_install -U mongoengine``. Otherwise, you can download the
3133
source from `GitHub <http://github.com/MongoEngine/mongoengine>`_ and run ``python
3234
setup.py install``.
@@ -114,7 +116,7 @@ Also use the -s argument if you want to print out whatever or access pdb while t
114116

115117
.. code-block:: shell
116118
117-
$ python setup.py nosetests --tests tests/test_django.py:QuerySetTest.test_get_document_or_404 -s
119+
$ python setup.py nosetests --tests tests/fields/fields.py:FieldTest.test_cls_field -s
118120
119121
Community
120122
=========

docs/django.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,5 +15,5 @@ The MongoEngine team is looking for help contributing and maintaining a new
1515
Django extension for MongoEngine! If you have Django experience and would like
1616
to help contribute to the project, please get in touch on the
1717
`mailing list <http://groups.google.com/group/mongoengine-users>`_ or by
18-
simpily contributing on
18+
simply contributing on
1919
`GitHub <https://github.com/MongoEngine/django-mongoengine>`_.

0 commit comments

Comments
 (0)