pymc-devs / pymc-devs/pytensor
DOC: Add pre-commit commands to CONTRIBUTING.md
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 644
- Forks
- 208
- Avg merge
- 2d 14h
- Merged PRs (30d)
- 16
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.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
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.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 86/100