-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add development environment setup instructions
- Loading branch information
1 parent
2e4cf10
commit 36ecba2
Showing
2 changed files
with
21 additions
and
21 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
|
||
# Code Contribution | ||
|
||
To contribute to this repository, please follow the steps below to set up your development environment. | ||
|
||
First, install all the recommended VSCode extensions for this workspace when prompted. | ||
|
||
Second, install poetry: | ||
|
||
``` sh | ||
pip install poetry | ||
|
||
# In the project root directory | ||
poetry install | ||
``` | ||
|
||
Third, install pre-commit hooks which will automatically reformat and lint the code when you make a commit: | ||
|
||
``` sh | ||
poetry run pre-commit install | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters