Skip to content

Commit 50a8df9

Browse files
committed
πŸ“¦πŸ“ Fix CONTRIBUTING.md documentation for recent changes in justfile
1 parent 1a41264 commit 50a8df9

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

β€Žproject_name/CONTRIBUTING.md.jinjaβ€Ž

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -46,22 +46,23 @@ Ready to get started? Follow the development setup below.
4646

4747
### Code Quality Tools
4848

49-
- **Format code**: `uv run just format` (runs `{{ "ruff format" if format_tool == "ruff" else format_tool }}`)
50-
- **Lint code**: `uv run just lint` (runs `ruff check` and `mypy`)
49+
- **Format code**: `uv run just format` (runs all the formatting tools)
50+
- **Lint code**: `uv run just lint` (runs all the linting tools)
51+
- **Format and lint code**: `uv run just quick-tools` (runs quick formatting and linting tools)
5152
- **Run tests**: `uv run just test` (runs `pytest`)
52-
- **Run pre-commit tests**: `uv run pre-commit run` (this also runs on each commit)
53-
- **Run all checks**: `uv run just check` (lint, test, and pre-commit)
53+
- **Run pre-commit tests**: `uv run pre-commit run`. This also runs on each commit.
54+
- **Run all checks**: `uv run just format lint test`
5455

5556
### Running Individual Tools
5657

5758
You can run specific tools directly:
5859

5960
```bash
6061
{% if format_tool == "black" %}uv run black{% endif %}
61-
uv run ruff
62+
uv run ruff check
6263
uv run mypy
6364
uv run pytest
64-
uv run pre-commit
65+
uv run pre-commit run
6566
```
6667

6768
[how-to-contribute]: https://opensource.guide/how-to-contribute/

0 commit comments

Comments
Β (0)