From 8a10451a7291bcbc933127ec789f10df1e50b6dd Mon Sep 17 00:00:00 2001 From: Tristan Lee Date: Mon, 7 Aug 2023 20:28:52 -0500 Subject: [PATCH] updated developer guide --- docs/source/developer_guide.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/developer_guide.rst b/docs/source/developer_guide.rst index 2fb512f..d797b6d 100644 --- a/docs/source/developer_guide.rst +++ b/docs/source/developer_guide.rst @@ -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 `_ to format source code. \ No newline at end of file +Cisticola uses `black `_ and `isort `_ to format source code. These packages are configured in a `pre-commit `_ hook in the root directory (``.pre-commit-config.yaml``) to ensure that all commits are properly formatted, which avoids unnecessarily large diffs. \ No newline at end of file