Skip to content

Commit 4dc2e6c

Browse files
Apply suggestions from code review
Co-authored-by: Philipp Hofmann <[email protected]>
1 parent 85da58f commit 4dc2e6c

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

develop-docs/sdk/processes/breaking_changes.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ The most obvious kind of breaking changes is changing the way the user interacts
2828
- Changing the type of an argument to an API function and not accepting the previous type anymore
2929

3030
In some SDKs, the line between public and private API is unclear. If unsure, discuss with your teammates. Some pointers:
31-
- Is the API mentioned in the user-facing docs? Then it's probably public and you should consider making changes to it in a major release.
31+
- Is the API mentioned in the user-facing docs? Then it's highly likely public, and you should consider making changes to it in a major release.
3232
- Was the code you're changing solely created for an internal purpose? Is it a utility function, or a helper function we added to make testing easier? Then it's fine to change.
3333
- Can you reasonably assume a significant portion of the user base is using this?
3434

@@ -43,7 +43,7 @@ We also need to be mindful of what the SDK change might cause in the product. So
4343
In general, we consider changes to the following product-side features potentially problematic:
4444
- **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.
4545
- **Dashboards:** A user has set up a dashboard that filters on specific data and we change that data. For instance, changing a span's `op` might mean a dashboard showing those spans will be empty after an SDK update.
46-
- **Alerts:** Alerts might stop firing because we've changed an attribute.
46+
- **Alerts:** Alerts might stop or start firing because we've changed an attribute.
4747

4848
Changes to grouping, dashboards and alerts need closer inspection. In order to make a good decision, you can try to estimate how many users are affected using our data analytics tools. It always needs a human/team to weigh in.
4949

0 commit comments

Comments
 (0)