You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+11-9Lines changed: 11 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -28,23 +28,25 @@ The usual release process goes like this:
28
28
29
29
1. Write the integration.
30
30
31
-
* Instrument all application instances by default. Prefer global signals/patches instead of configuring a specific instance. Don't make the user pass anything to your integration for anything to work. Aim for zero configuration.
31
+
* Instrument all application instances by default. Prefer global signals/patches instead of configuring a specific instance. Don't make the user pass anything to your integration for anything to work. Aim for zero configuration.
32
32
33
-
* Everybody monkeypatches. That means:
33
+
* Everybody monkeypatches. That means:
34
34
35
-
* Make sure to think about conflicts with other monkeypatches when monkeypatching.
35
+
* Make sure to think about conflicts with other monkeypatches when monkeypatching.
36
36
37
-
* You don't need to feel bad about it.
37
+
* You don't need to feel bad about it.
38
38
39
-
* Avoid modifying the hub, registering a new client or the like. The user drives the client, and the client owns integrations.
39
+
* Avoid modifying the hub, registering a new client or the like. The user drives the client, and the client owns integrations.
40
40
41
-
* Allow the user to disable the integration by changing the client. Check `Hub.current.get_integration(MyIntegration)` from within your signal handlers to see if your integration is still active before you do anything impactful (such as sending an event).
41
+
* Allow the user to disable the integration by changing the client. Check `Hub.current.get_integration(MyIntegration)` from within your signal handlers to see if your integration is still active before you do anything impactful (such as sending an event).
42
42
43
43
2. Write the [docs](https://github.com/getsentry/sentry-docs). Answer the following questions:
44
44
45
-
* What does your integration do? Split in two sections: Executive summary at top and exact behavior further down.
46
-
* Which version of the SDK supports which versions of the modules it hooks into?
47
-
* One code example with basic setup.
45
+
* What does your integration do? Split in two sections: Executive summary at top and exact behavior further down.
46
+
47
+
* Which version of the SDK supports which versions of the modules it hooks into?
48
+
49
+
* One code example with basic setup.
48
50
49
51
Tip: Put most relevant parts wrapped in `<!--WIZARD-->..<!--ENDWIZARD-->` tags for usage from within the Sentry UI.
0 commit comments