Skip to content

Define and Document Breaking Changes Policy for WPGraphQL #3173

@josephfusco

Description

@josephfusco

Overview

As a WPGraphQL maintainer, I would like a knowledge base of upgrade guides for breaking changes in order to ensure smooth transitions. This will provide clear, step-by-step instructions for users to upgrade without issues, minimizing downtime and frustrations.

As a WPGraphQL maintainer, I would like to define a breaking change policy, defining the following:

  • High Impact (e.g. breaking schema)
  • Medium Impact
  • Low Impact

Acceptance Criteria

  • Blog post announcing future breaking changes
  • Markdown file in repo explaining future breaking changes
  • Initial email sent to WPGraphQL's ~30k subscribers announcing future breaking changes (reference blog post)

Links

For inspiration:

Metadata

Metadata

Assignees

Labels

scope: docsUpdating, correcting, and improving documentation

Type

No type

Projects

Status

✅ Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions