Skip to content

Latest commit

 

History

History
109 lines (79 loc) · 4.22 KB

CONTRIBUTING.rst

File metadata and controls

109 lines (79 loc) · 4.22 KB
Raw

Contributing to MongoEngine

MongoEngine has a large community and contributions are always encouraged. Contributions can be as simple as minor tweaks to the documentation. Please read these guidelines before sending a pull request.

Bugfixes and New Features

Before starting to write code, look for existing tickets or create one for your specific issue or feature request. That way you avoid working on something that might not be of interest or that has already been addressed. If in doubt post to the user group <http://groups.google.com/group/mongoengine-users>

Supported Interpreters

MongoEngine supports CPython 3.5 and newer as well as Pypy3. Language features not supported by all interpreters can not be used.

Python3 codebase

Since 0.20, the codebase is exclusively Python 3.

Earlier versions were exclusively Python2, and were relying on 2to3 to support Python3 installs. Travis runs the tests against the main Python 3.x versions.

Style Guide

MongoEngine's codebase is auto-formatted with black, imports are ordered with isort and other tools like flake8 are also used. Those tools will run as part of the CI and will fail in case the code is not formatted properly.

To install all development tools, simply run the following commands:

$ python -m pip install -r requirements-dev.txt

You can install pre-commit into your git hooks, to automatically check and fix any formatting issue before creating a git commit.

To enable pre-commit simply run:

$ pre-commit install

See the .pre-commit-config.yaml configuration file for more information on how it works.

pre-commit will now run upon every commit and will reject anything that doesn't comply.

You can also run all the checks with pre-commit run -a, this is what is used in the CI.

Testing

All tests are run on Travis and any pull requests are automatically tested. 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 pull request if you don't know how to fix it, it will be easier for other people to work on it and it may get fixed faster.

General Guidelines

  • Avoid backward breaking changes if at all possible.
  • If you have to introduce a breaking change, make it very clear in your pull request's description. Also, describe how users of this package should adapt to the breaking change in docs/upgrade.rst.
  • Write inline documentation for new classes and methods.
  • Write tests and make sure they pass (make sure you have a mongod running on the default port, then execute pytest tests/ from the cmd line to run the test suite).
  • Ensure tests pass on all supported Python, PyMongo, and MongoDB versions. You can test various Python and PyMongo versions locally by executing tox. For different MongoDB versions, you can rely on our automated Travis tests.
  • Add enhancements or problematic bug fixes to docs/changelog.rst.
  • Add yourself to AUTHORS :)

Documentation

To contribute to the API documentation just make your changes to the inline documentation of the appropriate source code or rst file in a branch and submit a pull request. You might also use the github Edit button.

If you want to test your documentation changes locally, you need to install the sphinx and sphinx_rtd_theme packages. Once these are installed, go to the docs directory, run make html and inspect the updated docs by running open _build/html/index.html.