From 81b4b876eec3c2d3fc4434c279ca49a45707e472 Mon Sep 17 00:00:00 2001 From: Michael Hoffmann Date: Mon, 9 Feb 2026 15:13:19 +0100 Subject: [PATCH 1/3] Clarify attributes process --- develop-docs/sdk/processes/basics.mdx | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/develop-docs/sdk/processes/basics.mdx b/develop-docs/sdk/processes/basics.mdx index 11a94af4aeea54..e43214eb56ddaf 100644 --- a/develop-docs/sdk/processes/basics.mdx +++ b/develop-docs/sdk/processes/basics.mdx @@ -4,6 +4,10 @@ description: So you want to develop an SDK? Before you get started here are som sidebar_order: 1 --- + + This document uses key words such as "MUST", "SHOULD", and "MAY" as defined in [RFC 2119](https://www.ietf.org/rfc/rfc2119.txt) to indicate requirement levels. + + ## Run a Local Relay You do not need a local Sentry for SDK development but you will want to run a local @@ -39,6 +43,12 @@ a good idea to refer to already existing Sentry SDKs for input. In particular t transport design is not part of the documentation but generally quite similar between SDKs. +## Add data attributes to sentry-conventions + +Before shipping any new or changed attributes, they **MUST** first be defined in the [sentry-conventions](https://github.com/getsentry/sentry-conventions/) repository. This ensures that all SDKs use consistent naming and semantics, and that the conventions are reviewed and agreed upon before being shipped to users. + +If the convention you need doesn't exist yet, open a PR in [sentry-conventions](https://github.com/getsentry/sentry-conventions/) to propose it. Only after the convention has been merged should you implement it in an SDK. + ## Type out context in Relay To have a better understanding of various [context](https://develop.sentry.dev/sdk/data-model/event-payloads/contexts/) our SDKs emit, any newly added context should also be typed out in [Relay](https://github.com/getsentry/relay/tree/master/relay-event-schema/src/protocol/contexts). From 8f2757e39d28d63fbc03e2dd1a3e8720e1abbda8 Mon Sep 17 00:00:00 2001 From: Michael Hoffmann Date: Mon, 9 Feb 2026 15:18:30 +0100 Subject: [PATCH 2/3] wip --- develop-docs/sdk/processes/basics.mdx | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/develop-docs/sdk/processes/basics.mdx b/develop-docs/sdk/processes/basics.mdx index e43214eb56ddaf..a461f96528fee3 100644 --- a/develop-docs/sdk/processes/basics.mdx +++ b/develop-docs/sdk/processes/basics.mdx @@ -43,15 +43,13 @@ a good idea to refer to already existing Sentry SDKs for input. In particular t transport design is not part of the documentation but generally quite similar between SDKs. -## Add data attributes to sentry-conventions +## Define Conventions and Types Before Shipping -Before shipping any new or changed attributes, they **MUST** first be defined in the [sentry-conventions](https://github.com/getsentry/sentry-conventions/) repository. This ensures that all SDKs use consistent naming and semantics, and that the conventions are reviewed and agreed upon before being shipped to users. +Before shipping new or changed SDK behavior, make sure the relevant definitions exist outside your SDK first: -If the convention you need doesn't exist yet, open a PR in [sentry-conventions](https://github.com/getsentry/sentry-conventions/) to propose it. Only after the convention has been merged should you implement it in an SDK. +- **Semantic conventions:** New or changed attributes **MUST** first be defined in [sentry-conventions](https://github.com/getsentry/sentry-conventions/). If the convention you need doesn't exist yet, open a PR there to propose it. Only after the convention has been merged should you implement it in an SDK. This ensures all SDKs use consistent naming and semantics. -## Type out context in Relay - -To have a better understanding of various [context](https://develop.sentry.dev/sdk/data-model/event-payloads/contexts/) our SDKs emit, any newly added context should also be typed out in [Relay](https://github.com/getsentry/relay/tree/master/relay-event-schema/src/protocol/contexts). +- **Context types:** Any newly added [context](https://develop.sentry.dev/sdk/data-model/event-payloads/contexts/) **SHOULD** also be typed out in [Relay](https://github.com/getsentry/relay/tree/master/relay-event-schema/src/protocol/contexts) so that the schema stays in sync with what SDKs emit. ## Join us on Discord From 4cd53fdcc5aac5e549076809555a87110cd44245 Mon Sep 17 00:00:00 2001 From: Michael Hoffmann Date: Mon, 9 Feb 2026 16:51:57 +0100 Subject: [PATCH 3/3] wip --- develop-docs/sdk/processes/basics.mdx | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/develop-docs/sdk/processes/basics.mdx b/develop-docs/sdk/processes/basics.mdx index a461f96528fee3..4e20a771538c72 100644 --- a/develop-docs/sdk/processes/basics.mdx +++ b/develop-docs/sdk/processes/basics.mdx @@ -49,6 +49,11 @@ Before shipping new or changed SDK behavior, make sure the relevant definitions - **Semantic conventions:** New or changed attributes **MUST** first be defined in [sentry-conventions](https://github.com/getsentry/sentry-conventions/). If the convention you need doesn't exist yet, open a PR there to propose it. Only after the convention has been merged should you implement it in an SDK. This ensures all SDKs use consistent naming and semantics. + The merge process for sentry-conventions PRs: + 1. Open a PR with the proposed convention. + 2. Get an approval from at least one code owner. + 3. Wait at least 3 business days after the first approval to give other code owners a chance to review. + - **Context types:** Any newly added [context](https://develop.sentry.dev/sdk/data-model/event-payloads/contexts/) **SHOULD** also be typed out in [Relay](https://github.com/getsentry/relay/tree/master/relay-event-schema/src/protocol/contexts) so that the schema stays in sync with what SDKs emit. ## Join us on Discord