Clarify the pre-commit setup in the README file
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 68
- Forks
- 92
- Avg merge
- 2d 2h
- Merged PRs (30d)
- 16
Description
Thank you for pointing that out. The README file seems to be messing the pre-commit install step. I will clarify that.
Originally posted by @suhaibmujahid in https://github.com/mozilla/bugbot/pull/2773#discussion_r2607640748
Contributor guide
No contributing guide indexed for this repository
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 with the README section covering pre-commit setup and compare it with the expected pre-commit install step. Done means the README clearly explains that setup without the confusing wording noted in the issue.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 45/100