Check spelling of author names in PRs for RFCs, comments and reviews
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 171
- Forks
- 75
- Avg merge
- 2d 3h
- Merged PRs (30d)
- 20
Description
On https://github.com/German-BioImaging/ome-zarr-acknowledgments/blob/main/scripts/validate_contribs_vs_people.py, I have been comparing the names used on RFCs and similar with the names on https://german-bioimaging.github.io/ome-zarr-acknowledgments/.
This has led me to catch a few typos (https://github.com/ome/ngff/pull/450) .
After merging https://github.com/ome/ngff/pull/450, however, I ran the script again and found a new typo:
"Jeremy Maitin-Shephard" in https://github.com/ome/ngff/blob/main/rfc/5/comments/2/index.md should actually be ""Jeremy Maitin-Shepard"
It may not be trivial, but we could set up infrastructure to catch early (like codespell) if names of authors are correct, at least giving a warning in comparison to a reference https://github.com/German-BioImaging/ome-zarr-acknowledgments/blob/main/people.yaml
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 scripts/validate_contribs_vs_people.py and the reference people.yaml, then inspect rfc/5/comments/2/index.md and PR 450 for the reported name mismatch. Done means the validation workflow can compare author names in RFCs, comments, and reviews against the reference and emit a warning for mismatches.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100