Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .github/workflows/lint_and_docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ jobs:
- name: Lint sources
run: |
make lint PYTHON=python3
python3 -m pre_commit run --all-files --hook-stage pre-push
python3 -m prek run --all-files --hook-stage pre-push
- name: Build docs
run: |
towncrier build --version 99.99 --name pystack --keep
Expand Down
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,11 +61,11 @@ easier to validate it.

### Linting your code

Before commiting anything, install the pre-commit hooks:
Before commiting anything, install the prek (pre-commit) hooks:

```shell
python3 -m pip install -r requirements-extra.txt
pre-commit install
prek install
```

This will ensure that your contribution passes our linting checks.
Expand Down
4 changes: 2 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -79,11 +79,11 @@ ccoverage: ## Run the test suite, with C++ code coverage

.PHONY: format
format: ## Autoformat all files
$(PYTHON) -m pre_commit run --all-files
$(PYTHON) -m prek run --all-files

.PHONY: lint
lint: ## Lint all files
$(PYTHON) -m pre_commit run --all-files
$(PYTHON) -m prek run --all-files
$(PYTHON) -m mypy src/pystack --strict --ignore-missing-imports
$(PYTHON) -m mypy tests --ignore-missing-imports

Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,10 +92,10 @@ This will install PyStack in the virtual environment in development mode (the `-
`pip install` command), and then install the Python libraries needed to test it, lint it, and
generate its documentation.

If you plan to contribute back, you should install the pre-commit hooks:
If you plan to contribute back, you should install the prek (pre-commit) hooks:

```shell
pre-commit install
prek install
```

This will ensure that your contribution passes our linting checks.
Expand Down
2 changes: 1 addition & 1 deletion requirements-extra.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
mypy
bump2version
towncrier
pre-commit
prek
-r requirements-docs.txt
Loading