Skip to content

Expand the "Handling compatibility breakages" section#58

Open
southpawriter02 wants to merge 7 commits intogodotengine:mainfrom
southpawriter02:expand-compatibility-breakages
Open

Expand the "Handling compatibility breakages" section#58
southpawriter02 wants to merge 7 commits intogodotengine:mainfrom
southpawriter02:expand-compatibility-breakages

Conversation

@southpawriter02
Copy link

The "Handling compatibility breakages" section in engine/guidelines/index.rst had a TODO asking to elaborate on the types of compatibility and procedure. The only other content was a bare link to the external docs page. This meant a contributor landing here got no orientation before being sent elsewhere.

This fills in that section with a brief overview:

  • What each release level (patch, minor, major) promises about compatibility
  • The distinction between binary and source compatibility
  • When and why GDExtension compatibility methods are required
  • What the CI validation catches and what the error looks like
  • A note about the "breaks compat" label and review expectations

The external docs link is preserved at the bottom for anyone who needs the full technical walkthrough. The section is meant to orient contributors, not replace the external page, so it stays high-level on purpose.

@Ivorforce Ivorforce requested a review from a team February 9, 2026 20:08
@Ivorforce Ivorforce added the enhancement New feature or request label Feb 9, 2026
southpawriter02 and others added 2 commits February 15, 2026 13:42
Co-authored-by: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com>
Removed some very confusing high-level definitions.
Copy link
Member

@Ivorforce Ivorforce left a comment

Choose a reason for hiding this comment

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

LGTM

Before we can merge, please squash your changes down into a single commit.

Copy link
Member

@Calinou Calinou left a comment

Choose a reason for hiding this comment

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

Looks good to me.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants