doc: Document process of adding new integration

untitaker · untitaker · commit 28cce053a026 · 2019-08-16T20:47:21.000+02:00
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -20,6 +20,33 @@ must have `twine` installed globally.
 
 The usual release process goes like this:
 
-1. Go through git log and write new entry into `CHANGELOG.md`, commit to master
+1. Go through git log and write new entry into `CHANGES.md`, commit to master
 2. `craft p a.b.c`
 3. `craft pp a.b.c`
+
+## Adding a new integration (checklist)
+
+1. Write the integration.
+
+  * 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.
+
+  * Everybody monkeypatches. That means:
+
+    * Make sure to think about conflicts with other monkeypatches when monkeypatching.
+
+    * You don't need to feel bad about it.
+
+  * Avoid modifying the hub, registering a new client or the like. The user drives the client, and the client owns integrations.
+
+  * 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).
+
+2. Write the [docs](https://github.com/getsentry/sentry-docs). Answer the following questions:
+
+  * What does your integration do? Split in two sections: Executive summary at top and exact behavior further down.
+  * Which version of the SDK supports which versions of the modules it hooks into?
+  * One code example with basic setup.
+
+  Tip: Put most relevant parts wrapped in `<!--WIZARD-->..<!--ENDWIZARD-->` tags for usage from within the Sentry UI.
+
+3. Merge docs after new version has been released (auto-deploys on merge).
+4. (optional) Update data in [`sdk_updates.py`](https://github.com/getsentry/sentry/blob/master/src/sentry/sdk_updates.py) to give users in-app suggestions to use your integration. May not be applicable or doable for all kinds of integrations.
