The pre-commit hooks lack the issue-reference, traction and contributors checks that make lint runs

Open Beginner friendly
#1,276 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
72/100
Issue type
Feature
Clarity
Clearly specified
Activity status
Active
Tech stack
python, yaml
Domain
build-system

Research direction

Start with the lint target in Makefile to see how check_issue_refs.py, check_traction.py and check_contributors.py are invoked, then read .pre-commit-config.yaml to see the existing hook entries. Check which files each script reads so each new hook can be restricted to them, and confirm the missing-gh tolerance the scripts already have. Done when editing ROADMAP.md, METRICS.md, README.md or CONTRIBUTORS.md runs the matching hook under pre-commit.

Written by the indexing model from the issue text.

Description

enhancement tooling

Where: .pre-commit-config.yaml, Makefile (lint).

Current gap: make lint runs check_issue_refs.py, check_traction.py and check_contributors.py; the pre-commit config has hooks for the em-dash, link, explainer-count and explainer-structure checks and ruff, so a commit can pass the hooks and fail make lint.

Suggested approach: Add hooks for the three checks (restricted to the files they read, and tolerant of a missing gh as the scripts already are).

Done when: editing ROADMAP.md, METRICS.md, README.md or CONTRIBUTORS.md runs the matching hook.

Dominant language
HTML
Stars
47
Forks
45
Avg merge
3h 24m
Merged PRs (30d)
101

Getting set up

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 yakew7/Fair-Code

All issues in yakew7/Fair-Code

Similar issues

More Build System issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.