Clarify the pre-commit setup in the README file

Open
#2,774 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
45/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Domain
documentation

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.

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

Dominant language
Python
Stars
68
Forks
92
Avg merge
2d 2h
Merged PRs (30d)
16

Contributor guide

No contributing guide indexed for this repository

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 mozilla/bugbot

All issues in mozilla/bugbot

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.