Skip to content

Commit

Permalink
Add ruff guide to CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
garlic-os committed Aug 7, 2024
1 parent ee1e34b commit b427ef6
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,22 @@ git commit -a -m "Put here the synthetic commit message"
git push my_user_name my_new_feature_branch
```
### Formatting and linting with [Ruff](https://docs.astral.sh/ruff/) ###
Format your code to follow the style of the project with:
```
ruff format
```
and check for linting problems with:
```
ruff check
```
Please ensure that any linting problems in your changes are resolved before
submitting a pull request.
> [!TIP]
> vscode users can [install the ruff extension](https://marketplace.visualstudio.com/items?itemName=charliermarsh.ruff) to run the linter automatically in the
editor.
### Issue a pull request from GitHub UI ###
commit locally and push. To get a reasonable history, you may need to
Expand Down

0 comments on commit b427ef6

Please sign in to comment.