As a developer, I have an easy way to check my commit and code locally before pushing
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 10
- Forks
- 40
- Avg merge
- 21h 24m
- Merged PRs (30d)
- 8
Description
Author: daviddavis (daviddavis)
Redmine Issue: 6938, https://pulp.plan.io/issues/6938
I was talking to ggainey about some of the automation checks we have in pulp (commit validation, style/lint checks, changelog, etc) and how it might be frustrating for new devs. I've heard the same feedback from other contributors such as galaxy.
We need to provide an easy way for developers to run our CI checks locally. I've seen other projects (bandersnatch[0], black[1], celery[2], etc) use pre-commit:
[0] https://github.com/pypa/bandersnatch/blob/master/.pre-commit-config.yaml
[1] https://github.com/psf/black/blob/master/.pre-commit-config.yaml
[2] https://github.com/celery/celery/blob/master/.pre-commit-config.yaml
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
Start by reviewing the existing CI checks for commit validation, style and lint checks, and changelog handling, then compare the linked pre-commit examples. Done means developers have an easy local command or workflow that runs the relevant checks before pushing.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- ci-cd, developer-experience, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100