Skip to content

Commit f29c451

Browse files
committed
update readme with instructions to run code_style.sh
1 parent e4b4205 commit f29c451

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -178,10 +178,18 @@ MaxDiffusion started as a fork of [Diffusers](https://github.com/huggingface/dif
178178

179179
Whether you are forking MaxDiffusion for your own needs or intending to contribute back to the community, a full suite of tests can be found in `tests` and `src/maxdiffusion/tests`.
180180

181-
To run unit tests and lint, simply run:
181+
To run unit tests, simply run:
182182
```
183183
python -m pytest
184-
ruff check --fix .
185184
```
186185

186+
This project uses `pylint` and `pyink` to enforce code style. Before submitting a pull request, please ensure your code passes these checks by running:
187+
188+
```
189+
bash code_style.sh
190+
```
191+
192+
This script will automatically format your code with `pyink` and help you identify any remaining style issues.
193+
194+
187195
The full suite of -end-to end tests is in `tests` and `src/maxdiffusion/tests`. We run them with a nightly cadance.

0 commit comments

Comments
 (0)