diff --git a/packages/replay/CONTRIBUTING.md b/packages/replay/CONTRIBUTING.md new file mode 100644 index 000000000000..ad2cb89e36b8 --- /dev/null +++ b/packages/replay/CONTRIBUTING.md @@ -0,0 +1,5 @@ +## Updating the rrweb dependency + +When [updating the `rrweb` dependency](https://github.com/getsentry/sentry-javascript/blob/a493aa6a46555b944c8d896a2164bcd8b11caaf5/packages/replay/package.json?plain=1#LL55), +please be aware that in [addition to `@sentry/replay`'s README.md](https://github.com/getsentry/sentry-javascript/blob/a493aa6a46555b944c8d896a2164bcd8b11caaf5/packages/replay/README.md?plain=1#LL204), +Sentry docs also [point to a specific version of `rrweb`](https://github.com/getsentry/sentry-docs/blob/d6adadffc9e468ba777ccc733e69c373181237c9/src/platforms/javascript/common/session-replay/configuration.mdx?plain=1#LL49) that has configuration that needs to be updated.