Skip to content

Commit 0dff803

Browse files
committed
breaking changes when fixing a bug
1 parent 1f20eac commit 0dff803

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

develop-docs/sdk/processes/breaking_changes.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,9 @@ Naturally, the language of your SDK and the community around it also affects wha
4040

4141
### Changes in the Product
4242

43-
We also need to be mindful of what the SDK change might cause in the product. Sometimes we're forcing users to make changes in their use of Sentry because we, for example, broke a dashboard by renaming a span attribute. However, we also don't want to be in a position where we can't fix an attribute name without releasing a new major version of the SDK. Having to adopt a new major version every month is also not great UX.
43+
We also need to be mindful of what the SDK change might cause in the product. Sometimes we're forcing users to make changes in their use of Sentry because we, for example, broke a dashboard by renaming a span attribute. However, we also don't want to be in a position where we can't fix an attribute name without releasing a new major version of the SDK. Having to adopt a new major version every month is also not great UX in most languages.
44+
45+
An additional complicating factor is if removing an attribute or stopping to send certain spans is needed to fix a severe bug, like an SDK-induced app crash or hang. You should discuss with your teammates whether breaking SDK behavior as a knock-on effect from a bugfix warrants a major release.
4446

4547
In general, we consider changes to the following product-side features potentially problematic:
4648
- **Grouping:** An SDK change might result in error events being grouped differently, because we remove, add or change some of the data on the event that is used in the grouping algorithm on the server. When you think a change might affect grouping, it's recommended to try the change yourself and check in Sentry to see if grouping is preserved.

0 commit comments

Comments
 (0)