bellingcat/cisticola
1
0
Fork 0
mirror of https://github.com/bellingcat/cisticola.git synced 2026-06-07 19:08:35 +03:00
Code Issues Packages Projects Releases Wiki Activity

updated developer guide

Browse Source
This commit is contained in:
Tristan Lee
2023-08-07 20:28:52 -05:00
parent a89925b99e
commit 8a10451a72
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/source/developer_guide.rst
View File

@@ -4,7 +4,7 @@ Developer Guide
Installation
------------
To install the necessary dependencies for building the documentation and running unit tests, run the following command from the package root directory:
To install the necessary dependencies for building the documentation, running unit tests, and performing pre-commit linting, run the following command from the package root directory:
.. code-block::
@@ -20,4 +20,4 @@ If changes are made to the package structure or additional modules are created,
Formatting
----------
Cisticola uses `black <https://github.com/psf/black>`_ to format source code.
Cisticola uses `black <https://github.com/psf/black>`_ and `isort <https://pycqa.github.io/isort/>`_ to format source code. These packages are configured in a `pre-commit <https://pre-commit.com/>`_ hook in the root directory (``.pre-commit-config.yaml``) to ensure that all commits are properly formatted, which avoids unnecessarily large diffs.