Add a linter to require RFC-2119 keywords are capitalized
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 34
- Forks
- 43
- PR merge metrics
- No merged PRs in 30d
Description
This isn't a necessity, but it would be nice if the linter called out when keywords are used and forced capitalization of them. This can be useful for readers to understand when the reader intentionally wants a piece of text to be a normative statement (required for conformance to the spec) versus when the author is accidentally reusing a normative word and should update the text so that it's more clear this isn't required.
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
The issue names no files, tests, or entry points. Start by locating the linter implementation and its existing keyword checks, then review how linter tests are structured. Done means RFC-2119 keywords are reported when lowercase and accepted when correctly capitalized.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100