Skip to content

docs(spec): declare RFC 2119 normative keywords in FORMAT.md (OZA-50)#5

Merged
cstaszak merged 1 commit into
mainfrom
cstaszak/oza-50-spec-declare-rfc-2119-normative-keyword-usage-in-formatmd
May 24, 2026
Merged

docs(spec): declare RFC 2119 normative keywords in FORMAT.md (OZA-50)#5
cstaszak merged 1 commit into
mainfrom
cstaszak/oza-50-spec-declare-rfc-2119-normative-keyword-usage-in-formatmd

Conversation

@cstaszak

Copy link
Copy Markdown
Contributor

Summary

  • Adds a ## Conformance preamble (RFC 2119 boilerplate) at the top of docs/FORMAT.md, before §1
  • Audits every normative keyword occurrence and capitalises 14 of them: MUST, MUST NOT, SHOULD NOT, MAY
  • Descriptive uses in the "Why Redesign ZIM?" rationale section and ZIM-comparison table cells are intentionally left lowercase

Closes OZA-50.

Test plan

  • docs/FORMAT.md renders correctly (no broken Markdown)
  • All must/should/may remaining lowercase are in non-normative prose (ZIM rationale / comparison table)
  • make lint passes (docs-only change, no Go code touched)

🤖 Generated with Claude Code

Add Conformance preamble immediately before §1, declaring that MUST,
MUST NOT, REQUIRED, SHALL, SHALL NOT, SHOULD, SHOULD NOT, RECOMMENDED,
MAY, and OPTIONAL are interpreted per RFC 2119.

Audit and capitalise all normative OZA keywords throughout the spec
(14 changes). Descriptive uses in the "Why Redesign ZIM?" rationale
section and ZIM-comparison table cells are left lowercase.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@cstaszak
cstaszak merged commit d3a1ab1 into main May 24, 2026
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant