Update Contributing, changelog
This commit is contained in:
		| @@ -31,8 +31,28 @@ build. You should ensure that your code is properly converted by | ||||
| Style Guide | ||||
| ----------- | ||||
|  | ||||
| MongoEngine uses `black <https://github.com/python/black>`_ for code | ||||
| formatting. | ||||
| MongoEngine uses various tools to maintain a common coding style. | ||||
|  | ||||
| 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 | ||||
| ------- | ||||
|   | ||||
| @@ -25,6 +25,8 @@ Development | ||||
| - In bulk write insert, the detailed error message would raise in exception. | ||||
| - Added ability to compare Q and Q operations #2204 | ||||
| - 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 | ||||
| ================= | ||||
|   | ||||
| @@ -5,3 +5,4 @@ pre-commit | ||||
| pytest | ||||
| ipdb | ||||
| ipython | ||||
| tox | ||||
|   | ||||
		Reference in New Issue
	
	Block a user