Skip to content

Commit

Permalink
README: Added instruction for auto formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
Root-Core committed Sep 9, 2024
1 parent 65af67a commit dbea02b
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,12 @@ ruff check .

You are good to go when you see the message `All checks passed!`.

If not, try letting `ruff` (the linter we use) fix it automatically:

```bash
ruff format .
```

### Testing

The filenames of the fixes are checked against the Steam and GOG APIs. All symbolic links are also checked. This is not mandatory to run locally, as you should have a working game fix to begin with, and it will be done automatically by Github's CI.
Expand Down

0 comments on commit dbea02b

Please sign in to comment.