Skip to content

Commit

Permalink
Update code formatting section in contributing
Browse files Browse the repository at this point in the history
  • Loading branch information
AlbaHerrerias committed Jul 17, 2024
1 parent 9b2a2b1 commit 0c89ecb
Showing 1 changed file with 3 additions and 11 deletions.
14 changes: 3 additions & 11 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,19 +86,11 @@ Make sure to add tests for any new features or improvements made to the code. De


### Code formatting
Before committing changes, you can lint and reformat your code using [ruff](https://github.com/astral-sh/ruff) and [black](https://github.com/psf/black). To install these tools on your local machine or a virtual environment:
Before committing changes, you can lint and reformat your code. Please ensure you have [Docker](https://www.docker.com/) and [Compose](https://docs.docker.com/compose/) installed, and then run:

```sh
pip install black ruff
```

You can then run:
```sh
# lint
bin/lint
# format
black .
make lint
make reformat
```


Expand Down

0 comments on commit 0c89ecb

Please sign in to comment.