DOC: Add pre-commit commands to CONTRIBUTING.md

Open Beginner friendly
#2,215 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
86/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Quiet
Tech stack
python
Domain
documentation

Research direction

Open CONTRIBUTING.md and review the existing quick links and style-guide guidance. Add a short developer checks section with the documented pre-commit setup and all-files commands. Done means contributors can find and follow the commands locally to reproduce the relevant CI style checks.

Written by the indexing model from the issue text.

Description

Description

CONTRIBUTING.md links out to the PyMC Python style guide with pre-commit, but it does not include the concrete PyTensor developer commands that match CI.

It would be helpful to add a short section to CONTRIBUTING.md showing contributors how to set up and run pre-commit locally, for example:

pre-commit install
pre-commit run --all-files

This would make it easier for new contributors to reproduce the remote code style checks before opening or updating a PR.

Suggested location

Add a short developer checks section near the existing quick links in CONTRIBUTING.md.

Dominant language
Python
Stars
644
Forks
209
Avg merge
2d 14h
Merged PRs (30d)
16

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from pymc-devs/pytensor

All issues in pymc-devs/pytensor

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.