Implement pre commit ci
- Dominant language
- Python
- Stars
- 7
- Forks
- 10
- Avg merge
- 1d 19h
- Merged PRs (30d)
- 5
Description
# ✨ Feature Request
[pre-commit.ci](https://pre-commit.ci/) provides a way to run pre-commit on GitHub, rather than relying on developers having set up pre-commit locally. It also ensures pre-commit is run on web-based commits, and can automatically update hook versions.
## Requirements
We should investigate using pre-commit.ci, and weigh up the pros and cons. Some initial thoughts:
1. pre-commit.ci is free for open source repositories (see [pricing](https://pre-commit.ci/#pricing))
2. pre-commit.ci also provides a [lite version](https://pre-commit.ci/lite.html) which adds auto fixing to GitHub actions
3. We could remove pre-commit from our environments (and even the linting tools?)
4. If a pre-commit hook makes changes remotely, the developer has to pull the changes back to their local clone. This adds some friction, as it might not be clear when changes are being made
## Context
This should be run as part of the CI pipeline (on PRs and pushes to main)
Contributor guide
Research direction
Review the repository's current CI pipeline and local pre-commit setup first. Compare using pre-commit.ci with the existing approach, including pull requests, pushes to main, hook updates, auto-fixes, and possible removal of local tools; done means a documented decision and an implemented CI configuration if adoption is recommended.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions
- Domain
- ci-cd, devops
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100