When is an API change needed during the API completion phase?

Last updated on
11 March 2021

This documentation needs work. See "Help improve this page" in the sidebar.

As stated in the release cycle policy, backwards compatibility-breaking API changes are only allowed during the API completion phase when they are needed to fix major and critical bugs and tasks. The flowchart below describes the process for resolving these issues:

Flowchart for API changes during the API completion phase

Updating the issue summary

* Before you reach out to a core maintainer about a particular issue, ensure that the issue summary is up to date. It should contain the following information:

  1. The goal of the issue. (Why is it needed?)
  2. Why the issue is major or critical.
  3. A summary of the API changes introduced by the patch.

See the issue summary instructions for more information.

Asking a maintainer

** When possible, work with a component maintainer for the component to escalate the issue to a core committer.

Help improve this page

Page status: Needs work

You can: