Skip to content

Commit

Permalink
Updated the CONTRIBUTING.md to mention isort and black (#39)
Browse files Browse the repository at this point in the history
* Updated the CONTRIBUTING.md to mention isort and black

* bump version to 0.12.1

* Now actually checking code style
  • Loading branch information
williamjameshandley authored Apr 30, 2024
1 parent 2901f25 commit 8ed13a8
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 6 deletions.
6 changes: 3 additions & 3 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ Note that a [code of conduct](https://github.com/handley-lab/lsbi/blob/master/CO

## Contributing - `pre-commit`

lsbi uses flake8 and pydocstyle to maintain a consistent style. To speed up linting, contributors can optionally use pre-commit to ensure their commits comply.
lsbi uses black and isort to maintain a consistent style. To speed up linting, contributors can optionally use pre-commit to ensure their commits comply.

First, ensure that pre-commit, flake8 and pydocstyle are installed:
First, ensure that pre-commit, black and isort are installed:
```
pip install pre-commit flake8 pydocstyle
pip install pre-commit black isort
```
Then install the pre-commit to the .git folder:
```
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/code_style.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -46,4 +46,4 @@ jobs:
- name: Install pydocstyle
run: pip install pydocstyle
- name: run pydocstyle
run: python -m pydocstyle --convention=numpy anesthetic
run: python -m pydocstyle --convention=numpy lsbi
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ lsbi: Linear Simulation Based Inference
=======================================
:lsbi: Linear Simulation Based Inference
:Author: Will Handley & David Yallup
:Version: 0.12.0
:Version: 0.12.1
:Homepage: https://github.com/handley-lab/lsbi
:Documentation: http://lsbi.readthedocs.io/

Expand Down
2 changes: 1 addition & 1 deletion lsbi/_version.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = "0.12.0"
__version__ = "0.12.1"

0 comments on commit 8ed13a8

Please sign in to comment.