Skip to content

Commit 9194814

Browse files
python357-1SysAdminDoc
authored andcommitted
docs: update CONTRIBUTING.md ruff instructions (TagStudioDev#581)
* docs: add warning about ruff on linux * Update CONTRIBUTING.md ---------
1 parent d99b43c commit 9194814

1 file changed

Lines changed: 6 additions & 2 deletions

File tree

CONTRIBUTING.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -92,8 +92,12 @@ A Python linter and code formatter. Ruff uses the `pyproject.toml` as its config
9292

9393
#### Running Locally
9494

95-
- Lint code by moving into the `/tagstudio` directory with `cd tagstudio` and running `ruff --config ../pyproject.toml`.
96-
- Format code with `ruff format` inside the repository directory
95+
Inside the root repository directory:
96+
- Lint code with `ruff check`
97+
- Some linting suggestions can be automatically formatted with `ruff check --fix`
98+
- Format code with `ruff format`
99+
100+
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).
97101

98102
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/).
99103

0 commit comments

Comments
 (0)