CHANGES.md checks in CI are insufficient for the desired level of pedantry
Nobody has claimed this yet.
- Dominant language
- C
- Stars
- 30.8k
- Forks
- 11.5k
- Avg merge
- 10m
- Merged PRs (30d)
- 1
Description
The checks for CHANGES.md in CI do not catch basic formatting pedantry that appears to be desired.
For example, some folks care about the number of leading spaces in a CHANGES.md file.
As none of these requirements are actually documented anywhere, the CHANGES.md checks in
ci should catch these things so that they can be fixed not by wasting the limited processing power of
meatspace entities on mindless pedantry better done by a computer.
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 examining the existing CHANGES.md checks in ci and the formatting expectations described in the issue. Identify the missing requirements, including leading-space handling, then add CI coverage for the agreed rules. Done when CI reliably rejects the formatting violations that the project intends to prevent.
Written by the indexing model from the issue text.
Assessment
- Domain
- ci-cd
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 38/100