Rules: Note RFC 2119 keyword preservation in title-case rules #5584

This commit is contained in:
Michael Mayer 2026-05-18 15:44:21 +00:00
parent 50439efc77
commit f5725a35ad
2 changed files with 2 additions and 0 deletions

View file

@ -46,6 +46,7 @@ The repo's issue templates use the new GitHub `type:` property (`Bug`, `Feature`
> - Capitalize the first word, the first word after a colon, dash, or end punctuation, and all major words, including the second part of a hyphenated major word.
> - Lowercase only articles, short conjunctions, and short prepositions of three letters or fewer when they are not in one of those positions.
> - Preserve known acronyms (for example, API, CLI, HTTP, JSON) and slash-separated acronym groups (for example, CSV/TSV) as uppercase.
> - Preserve RFC 2119 / RFC 8174 normative keywords (MUST, SHOULD, MAY, SHALL, REQUIRED, RECOMMENDED, OPTIONAL) as uppercase when used in their normative sense.
> - Preserve inline code spans (`` `foo` ``), file paths (e.g. `docs/foo-bar.md`), and slash commands (e.g. `/grill-me`) verbatim; do not recase their contents.
> - Use `&` instead of `And`/`Or` in headings.