Skip to content

Add pre-commit setup commands to CONTRIBUTING.md #2222

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

Open
karlhillx wants to merge 1 commit into
base: main
Choose a base branch
from
+16 −0
Open

Add pre-commit setup commands to CONTRIBUTING.md #2222

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
16 changes: 16 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,3 +32,19 @@ Most of these point to PyMC documentation, but are equally relevant for PyTensor
* [Python style guide with pre-commit](https://docs.pymc.io/en/latest/contributing/python_style.html)
* [Running the test suite](https://docs.pymc.io/en/latest/contributing/running_the_test_suite.html)
* [Submitting a bug report or feature request](https://github.com/pymc-devs/pytensor/issues)

## Running code style checks locally

PyTensor uses [pre-commit](https://pre-commit.com/) to run the same code style
checks as CI. After installing the development dependencies, set it up once:

```bash
pre-commit install
```

This runs the checks automatically on every commit. To run them across the
whole codebase at any time (for example, before opening or updating a PR):

```bash
pre-commit run --all-files
```