Skip to content

Explain our SemVer guarantees in the READMe - #2506

Merged
mromaszewicz merged 2 commits into
oapi-codegen:mainfrom
mromaszewicz:chore/readme
Aug 1, 2026
Merged

mromaszewicz merged 2 commits into
oapi-codegen:mainfrom
mromaszewicz:chore/readme

Conversation

@mromaszewicz

Copy link
Copy Markdown
Member

No description provided.

@mromaszewicz
mromaszewicz requested a review from a team as a code owner August 1, 2026 02:20
@greptile-apps

greptile-apps Bot commented Aug 1, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

Adds documentation clarifying the project’s SemVer policy and compatibility boundaries.

  • Describes compatibility expectations for generated code.
  • Defines the supported programmatic import surface around Generate and Configuration.
  • Marks custom template overrides and their contexts as unstable.

Confidence Score: 5/5

The documentation-only change appears safe to merge.

The added guidance consistently distinguishes generated-code compatibility, the supported programmatic API surface, and unstable template overrides, with no concrete misleading guarantee identified.

Important Files Changed

Filename Overview
README.md Adds internally consistent SemVer guidance without changing runtime behavior or introducing an actionable documentation defect.

Reviews (1): Last reviewed commit: "Explain our SemVer guarantees in the REA..." | Re-trigger Greptile

Comment thread README.md

@jamietanna jamietanna left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Otherwise LGTM, good to make it clearer!

@jamietanna

Copy link
Copy Markdown
Member

Do we think this will close #2168 or not yet?

Co-authored-by: Jamie Tanna <github@jamietanna.co.uk>
@mromaszewicz
mromaszewicz enabled auto-merge (squash) August 1, 2026 12:01
@mromaszewicz
mromaszewicz disabled auto-merge August 1, 2026 12:02
@mromaszewicz
mromaszewicz merged commit 23a02d3 into oapi-codegen:main Aug 1, 2026
15 checks passed
@mromaszewicz
mromaszewicz deleted the chore/readme branch August 1, 2026 12:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants