make key-fold-check is undocumented and nothing checks that every Makefile target is described

Open Beginner friendly
#1,275 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
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
javascript, python

Research direction

Start with the ## description lines in the Makefile and the list of make commands in CONTRIBUTING.md, then find where key-fold-check is defined to see what it checks. Add a CONTRIBUTING.md line for make key-fold-check, and add a test that parses the Makefile for described targets and fails when one is missing from CONTRIBUTING.md, skipping help. Done when adding a new described target without a CONTRIBUTING line makes that test fail.

Written by the indexing model from the issue text.

Description

documentation good first issue testing

Where: CONTRIBUTING.md, Makefile.

Current gap: Every documented target is listed in CONTRIBUTING except help and key-fold-check, so the check that the JS case-folding table still matches Python is not mentioned where contributors look.

Suggested approach: Document make key-fold-check and add a test that each target with a ## description appears as make <target> in CONTRIBUTING (with help as the one exception).

Done when: the test fails when a new target is added without a CONTRIBUTING line.

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.