diff --git a/wg-api/best-practices.md b/wg-api/best-practices.md index f6e53c162..b962265f3 100644 --- a/wg-api/best-practices.md +++ b/wg-api/best-practices.md @@ -13,7 +13,7 @@ API changes which alter existing behavior can cause apps to break unexpectedly w If the behavior must change to support the feature, the change should be listed in [the breaking changes document](https://github.com/electron/electron/blob/main/docs/breaking-changes.md). Additionally, consider whether the change can be introduced in a way which permits a deprecation cycle, for instance introducing the new API under a new name and deprecating the old name while keeping the behavior unchanged for apps using the API under the old name. > [!NOTE] -> Changes that only affect TypeScript type definitions are not considered breaking changes. +> Breaking changes should be that which affects JavaScript runtime usage. If a change affects type definitions which breaks static compilation of a TypeScript app, that is not enough to be considered a breaking change. ### How will this API be extended in the future?