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: develop-docs/sdk/expected-features/setup-wizards/index.mdx
+13-6Lines changed: 13 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -53,15 +53,22 @@ For instance:
53
53
Related to this, wizards should [check the git status](#1-check-preconditions) of the project and warn users if they're not in a clean state.
54
54
This ensures that users can revert the changes easily if something goes wrong.
55
55
56
-
### Cater to the 80%
56
+
### Respect Users' decisions
57
+
58
+
Wizards should allow users to select the high-level Sentry features (e.g. tracing, replay, profiling) they want to install.
59
+
The SDK setup should be minimal, may be opinionated ("whatever makes sense for the platform") but
60
+
must respect users' decisions.
57
61
58
-
Wizards should be opinionated in which SDK options are set and cater to the 80% use case.
59
-
The SDK setup doesn't necessarily have to be minimal.
60
-
For example, it can include optional but recommended integrations (e.g. session replay or profiling) or options (e.g. sample rates).
62
+
Some examples:
63
+
- We should not enable a feature that users previously declined (e.g. set `tracesSampleRate` if users previously declined to enable tracing)
64
+
- We may set additional options, like the `tunnelRoute` option in Next.Js, but we should ask for consent whenever reasonable.
65
+
- We may set additional options like `tracePropagationTargets` or `sendDefaultPii` as comments, if we think that these are options users should be aware of.
66
+
67
+
### Cater to the 80%
61
68
62
69
Given that most wizards will actively modify code or config files, there is a chance that they might fail or break something.
63
-
That's okay and expected as long as we're transparent about it and we tell users upfront that we're touching their files.
64
-
We cannot possibly cover all edge cases but we should try to cover the 80% so that typical projects can be set up with the wizard.
70
+
That's okay and expected as long as we're transparent about it and we tell users upfront that we're modifying their files.
71
+
We cannot possibly cover all edge cases but we should try to cover the 80% so that typical projects can be set up successfully.
0 commit comments