Skip to content

Commit 72a15fd

Browse files
committed
docs: add warning about ruff on linux
1 parent f21d49d commit 72a15fd

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,9 @@ A Python linter and code formatter. Ruff uses the `pyproject.toml` as its config
9595
- Lint code by moving into the `/tagstudio` directory with `cd tagstudio` and running `ruff --config ../pyproject.toml`.
9696
- Format code with `ruff format` inside the repository directory
9797

98+
> [!CAUTION]
99+
> At least one contributor has had issues with running ruff on Linux this way. If when you run ruff, you are getting more or different formatting issues than appear in CI, try running `ruff <command> --config pyproject.toml` in the directory you cloned TagStudio in (i.e. one directory above `/tagstudio`).
100+
98101
Ruff is also available as a VS Code [extension](https://marketplace.visualstudio.com/items?itemName=charliermarsh.ruff), PyCharm [plugin](https://plugins.jetbrains.com/plugin/20574-ruff), and [more](https://docs.astral.sh/ruff/integrations/).
99102

100103
### [Mypy](https://github.com/python/mypy)

0 commit comments

Comments
 (0)