Skip to content

refactor(api): one instruction per rule - #2121

Merged
braboj merged 2 commits into
mainfrom
refactor/api-score
Oct 22, 2026
Merged

braboj merged 2 commits into
mainfrom
refactor/api-score

Conversation

@braboj

@braboj braboj commented Oct 21, 2026

Copy link
Copy Markdown
Collaborator

Raises backend/api from 94.9 to 100.0: under half its bullets were instructions.

Section (IDs kept) Change
API-first The two MUSTs as instructions; the "Benefits:" bullet becomes the reason in the first rule
Protocol selection Statements → instructions; "REST + gRPC is valid" → an explicit MAY
OpenAPI Spec MUSTs kept; design-first, drift, contract-test and info.version rules shortened
Versioning MUST and MUST NOT kept; "Alternatively, use a header" → where a path prefix does not fit
Backward compatibility The breaking and non-breaking lists → three rules; the no-bump MUST NOT kept
Statelessness, Pagination MUSTs as instructions

Checks

  • Smoke 35/35; conformance 12 passed, 0 failed, 1 not applicable; readings read
  • Fork sync, redundancy audit, score ratchet, markdownlint, pre-commit hooks

No CHANGELOG entry: the rules are unchanged in meaning.

🤖 Generated with Claude Code

braboj and others added 2 commits October 22, 2026 00:53
Statements ("Every API MUST have", "Benefits:") and the breaking and
non-breaking lists become instructions. Every MUST and MUST NOT stays;
"REST plus gRPC is valid" becomes an explicit MAY.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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