Skip to content

Commit 77e278b

Browse files
committed
update README, black and isort cleanups
1 parent 7bbfd64 commit 77e278b

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,7 @@ warning: no files found matching 'gitmodules/...
9696
```
9797
Since git clone was done without recursive option, try: `git submodule update --init`
9898

99+
## Notes for developers
99100
#### How to debug
100101
```sh
101102
git clone --recursive git+https://github.com/open-atmos/PyPartMC.git
@@ -104,6 +105,8 @@ DEBUG=1 VERBOSE=1 pip --verbose install -e .
104105
gdb python
105106
(gdb) run -m pytest -s -vv -We -p no:unraisableexception tests
106107
```
108+
#### Pre-commit hooks
109+
PyPartMC codebase benefits from Pylint, Black and isort code analysis (which are all part of the CI workflows where we also use pre-commit hooks. The pre-commit hooks can be run locally, and then the resultant changes need to be staged before committing. To set up the hooks locally, install pre-commit via `pip install pre-commit` and set up the git hooks via `pre-commit install` (this needs to be done every time you clone the project). To run all pre-commit hooks, run `pre-commit run --all-files`. The `.pre-commit-config.yaml` file can be modified in case new hooks are to be added or existing ones need to be altered.
107110

108111
## Credits
109112

0 commit comments

Comments
 (0)