docs: update CONTRIBUTING.md ruff instructions (TagStudioDev#581)

* docs: add warning about ruff on linux * Update CONTRIBUTING.md Co-authored-by: Travis Abendshien <[email protected]> --------- Co-authored-by: Travis Abendshien <[email protected]>
Nginearing · Nov 8, 2024 · d75729b · d75729b
1 parent f21d49d
commit d75729b
Showing 1 changed file with 6 additions and 2 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -92,8 +92,12 @@ A Python linter and code formatter. Ruff uses the `pyproject.toml` as its config
 
 #### Running Locally
 
-- Lint code by moving into the `/tagstudio` directory with `cd tagstudio` and running `ruff --config ../pyproject.toml`.
-- Format code with `ruff format` inside the repository directory
+Inside the root repository directory:
+- Lint code with `ruff check`
+  - Some linting suggestions can be automatically formatted with `ruff check --fix`
+- Format code with `ruff format`
+
+Ruff should automatically discover the configuration options inside the [pyproject.toml](https://github.com/TagStudioDev/TagStudio/blob/main/pyproject.toml) file. For more information, see the [ruff configuration discovery docs](https://docs.astral.sh/ruff/configuration/#config-file-discovery).
 
 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/).