forked from ynput/OpenPype
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
58e00b2
commit e46431b
Showing
1 changed file
with
26 additions
and
0 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,26 @@ | ||
## Getting started | ||
|
||
### First steps | ||
|
||
At the beginning you have to create a working environment, you can achieve it with bootstrap scripts from `tools` folder. Just follow the tutorial from the main `README.md` [file](../../../README.md). | ||
|
||
### Hooks | ||
|
||
You will need to install followed packages: | ||
- pre-commit | ||
- black | ||
- mypy | ||
|
||
```bash | ||
pip install pre-commit black mypy | ||
``` | ||
In order to make pre-commit work within the project you need to activate it at the root level. | ||
|
||
```bash | ||
pre-commit install | ||
``` | ||
At the end you are supposed to see a message as below: | ||
``` | ||
pre-commit installed at .git/hooks/pre-commit | ||
``` | ||
Pre-commit will check your code style and formatting. You can configure the IDE of your choice to be able to use `pre-commit` and/or `black` formatter. |