Skip to content

Add Makefile check rule to run all the linters and checkers #1038

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 8, 2025
Merged

Add Makefile check rule to run all the linters and checkers #1038

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ format:
uv run ruff format
uv run ruff check --fix

.PHONY: format-check
format-check:
uv run ruff format --check

.PHONY: lint
lint:
uv run ruff check
Expand Down Expand Up @@ -55,5 +59,5 @@ serve-docs:
deploy-docs:
uv run mkdocs gh-deploy --force --verbose

.PHONY: check
check: format-check lint mypy tests
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,10 +170,16 @@ make sync

2. (After making changes) lint/test

```
make check # run tests linter and typechecker
```

Or to run them individually:
```
make tests # run tests
make mypy # run typechecker
make lint # run linter
make format-check # run style checker
```

## Acknowledgements
Expand Down