Process: Add checklist item about API changes in a PR #21499
Closed
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
To avoid situations where data corruption can be a result of changing API (see #18616 which started storing escaped titles in the database), we need to better aware of such changes. Most API changes will be without side-effects but without awareness of potential breaking changes, those that do have side-effects might be recognized too late.
By flagging API changes, they can be reviewed in bulk before a release, and the correct measures can be taken, for examply by adding a Changelog entry.
Types of changes
Adds a new checklist item to the PR template:
[ ] My code adds or changes API interaction.
Checklist:
(none apply since this is not a code change)
Proposal in change of process
We should create a new status label
Changes API
so that we can review API changes before releases. There should also be new labelsRequires Changelog Entry
andHas Changelog Entry
which can be used in such a case but might be useful in further scenarios when we want to ensure that important changes are not forgotten in changelogs.