Skip to content

Commit

Permalink
Change linter, ruff to black
Browse files Browse the repository at this point in the history
  • Loading branch information
dheavy committed Apr 7, 2024
1 parent 28b0583 commit 130c0ac
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 8 deletions.
9 changes: 4 additions & 5 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
repos:
- repo: https://github.com/astral-sh/ruff-pre-commit
rev: "v0.2.2"
- repo: https://github.com/psf/black
rev: 24.3.0 # Use the latest revision of Black
hooks:
- id: ruff
args: ["--fix"]
- id: ruff-format
- id: black
language_version: python3
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.5.0
hooks:
Expand Down
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,15 +55,15 @@ Then run `poetry install` again. If this doesn't work, please join our [Discord

## Code Formatting and Linting

Our project uses `ruff` for code formatting and `isort` for import sorting. To ensure consistency across contributions, please adhere to the following guidelines:
Our project uses `black` for code formatting and `isort` for import sorting. To ensure consistency across contributions, please adhere to the following guidelines:

1. **Install Pre-commit Hooks**:

To automatically format your code every time you make a commit, install the pre-commit hooks.

```bash
cd software # Change into `software` directory if not there already.
poetry shell # /!\ You MUST do it the virtual environment of your project
poetry shell # It's better to do it within the virtual environment of your project
poetry add --dev pre-commit # Install pre-commit as a dev dependency
pre-commit install
```
Expand All @@ -75,7 +75,7 @@ Our project uses `ruff` for code formatting and `isort` for import sorting. To e
If you choose not to use the pre-commit hooks, you can manually format your code using:

```bash
ruff .
black .
isort .
```

Expand Down

0 comments on commit 130c0ac

Please sign in to comment.