Skip to content

Commit e34be0f

Browse files
committed
chore: add note about formatting to Contributing docs
1 parent ab9cddc commit e34be0f

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,10 +45,16 @@ Once you've forked the code and created a new branch for your work, you can run
4545

4646
After modifying the source code, you will need to do `poetry run interpreter` again.
4747

48+
**Note**: This project uses [`black`](https://black.readthedocs.io/en/stable/index.html) and [`isort`](https://pypi.org/project/isort/) via a [`pre-commit`](https://pre-commit.com/) hook to ensure consistent code style.
49+
4850
### Installing New Packages
4951

5052
If you wish to install new dependencies into the project, please use `poetry add package-name`.
5153

54+
#### Installing Developer Dependencies
55+
56+
If you need to install dependencies specific to development, like testing tools, formatting tools, etc. please use `poetry add package-name --group dev`.
57+
5258
### Known Issues
5359

5460
For some, `poetry install` might hang on some dependencies. As a first step, try to run the following command in your terminal:

0 commit comments

Comments
 (0)