Update Contributing, changelog

This commit is contained in:
Filip Kucharczyk 2019-12-05 01:10:54 +01:00
parent 648b28876d
commit abc159b7b9
3 changed files with 25 additions and 2 deletions

View File

@ -31,8 +31,28 @@ build. You should ensure that your code is properly converted by
Style Guide Style Guide
----------- -----------
MongoEngine uses `black <https://github.com/python/black>`_ for code MongoEngine uses various tools to maintain a common coding style.
formatting.
To install all development tools, simply run the following commands:
.. code-block:: console
$ python -m pip install -r requirements-dev.txt
You can install `pre-commit <https://pre-commit.com/>`_ into your git hooks,
to automatically check and fix any formatting issue before creating a
git commit.
Simply run the following command:
.. code-block:: console
$ pre-commit install
See the ``.pre-commit-config.yaml`` configuration file for more information
on how it works.
Testing Testing
------- -------

View File

@ -25,6 +25,8 @@ Development
- In bulk write insert, the detailed error message would raise in exception. - In bulk write insert, the detailed error message would raise in exception.
- Added ability to compare Q and Q operations #2204 - Added ability to compare Q and Q operations #2204
- Added ability to use a db alias on query_counter #2194 - Added ability to use a db alias on query_counter #2194
- Added pre-commit
- Renamed requirements-lint.txt to requirements-dev.txt
Changes in 0.18.2 Changes in 0.18.2
================= =================

View File

@ -5,3 +5,4 @@ pre-commit
pytest pytest
ipdb ipdb
ipython ipython
tox