some more update, mainly docs

This commit is contained in:
mrigal 2015-04-30 14:52:08 +02:00 committed by Matthieu Rigal
parent 217c9720ea
commit 307b35a5bf
3 changed files with 14 additions and 4 deletions

View File

@ -29,7 +29,10 @@ Style Guide
----------- -----------
MongoEngine aims to follow `PEP8 <http://www.python.org/dev/peps/pep-0008/>`_ 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 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 and any pull requests are automatically tested by Travis. Any pull requests
without tests will take longer to be integrated and might be refused. 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 General Guidelines
------------------ ------------------
@ -48,6 +55,7 @@ General Guidelines
from the cmd line to run the test suite). from the cmd line to run the test suite).
- Ensure tests pass on every Python and PyMongo versions. - Ensure tests pass on every Python and PyMongo versions.
You can test on these versions locally by executing ``tox`` You can test on these versions locally by executing ``tox``
- Add enhancements or problematic bug fixes to docs/changelog.rst
- Add yourself to AUTHORS :) - Add yourself to AUTHORS :)
Documentation Documentation

View File

@ -26,7 +26,9 @@ a `tutorial <http://readthedocs.org/docs/mongoengine-odm/en/latest/tutorial.html
Installation 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 you can use ``easy_install -U mongoengine``. Otherwise, you can download the
source from `GitHub <http://github.com/MongoEngine/mongoengine>`_ and run ``python source from `GitHub <http://github.com/MongoEngine/mongoengine>`_ and run ``python
setup.py install``. 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 .. 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 Community
========= =========

View File

@ -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 Django extension for MongoEngine! If you have Django experience and would like
to help contribute to the project, please get in touch on the to help contribute to the project, please get in touch on the
`mailing list <http://groups.google.com/group/mongoengine-users>`_ or by `mailing list <http://groups.google.com/group/mongoengine-users>`_ or by
simpily contributing on simply contributing on
`GitHub <https://github.com/MongoEngine/django-mongoengine>`_. `GitHub <https://github.com/MongoEngine/django-mongoengine>`_.