diff options
| author | Michael Deyaso <mdeyaso@fusioniq.io> | 2023-03-25 13:34:30 +0300 |
|---|---|---|
| committer | Sasha Boginsky <41092741+sashadev-sky@users.noreply.github.com> | 2023-05-05 23:51:09 -0400 |
| commit | 9e7b20660b3792f64b83b37b0e62f56a93f46b79 (patch) | |
| tree | 819ae7f527c9908cd5f0e84948ab0dfc723697d9 /docs | |
| parent | 0067077f7a9e1f3b6f9fa0fc4e7859cef784c6f6 (diff) | |
Installed and configured pre-commit to lint and format code. Fixes #7476
(cherry picked from commit 98d1c65b404e77756289e32d1ef718318a36ece7)
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/development.rst | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/docs/development.rst b/docs/development.rst index d54c6c4e9..51e11bf34 100644 --- a/docs/development.rst +++ b/docs/development.rst @@ -164,6 +164,13 @@ virtual env and run:: pip install -r requirements.d/development.txt +This project utilizes pre-commit to format and lint code before it is committed. +Although pre-commit is installed when running the command above, the pre-commit hooks +will have to be installed separately. Run this command to install the pre-commit hooks:: + + pre-commit install + + Running the tests ----------------- |