Skip to content

Commit 56a9e6b

Browse files
committed
Update following Ruff replacing formatter script
Signed-off-by: Martin Hickey <[email protected]>
1 parent 592590c commit 56a9e6b

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ You can setup your dev environment using `tox`, an environment orchestrator whic
8686
pip install tox
8787
```
8888

89-
If you want to manage your own virtual environment () instead of using `tox`, you can install model optimizer and all dependencies. Check out [installation](./README.md#installation) foir more details.
89+
If you want to manage your own virtual environment instead of using `tox`, you can install the model optimizer and all dependencies. Check out [installation](./README.md#installation) for more details.
9090

9191
Before pushing changes to GitHub, you need to run the tests and coding style as shown below. They can be run individually as shown in each sub-section or can be run with the one command:
9292

@@ -114,12 +114,12 @@ tox -e unit -- tests/models/test_qmodelprep.py::test_double_qmodel_prep_assert
114114

115115
FMS Model Optimizer follows the Python [pep8](https://peps.python.org/pep-0008/) coding style. The coding style is enforced by the CI system, and your PR will fail until the style has been applied correctly.
116116

117-
We use [pre-commit](https://pre-commit.com/) to enforce coding style using [black](https://github.com/psf/black), and [isort](https://pycqa.github.io/isort/).
117+
We use [Ruff](https://docs.astral.sh/ruff/) to enforce coding style using [Black](https://github.com/psf/black), [isort](https://pycqa.github.io/isort/), and [Flake8](https://docs.astral.sh/ruff/faq/#how-does-ruffs-linter-compare-to-flake8).
118118

119-
You can invoke formatting with:
119+
You can invoke Ruff with:
120120

121121
```sh
122-
tox -e fmt
122+
tox -e ruff
123123
```
124124

125125
You could optionally install the git [pre-commit hooks](https://pre-commit.com/) if you would like to format the code automatically for each commit:
@@ -136,6 +136,7 @@ You can invoke the linting with the following command
136136
```shell
137137
tox -e lint
138138
```
139+
139140
## Your First Code Contribution
140141

141142
Unsure where to begin contributing? You can start by looking through these issues:

0 commit comments

Comments
 (0)