From 4711079846bcf6654a5f64540ea97c411f6be202 Mon Sep 17 00:00:00 2001 From: Bruno Garcia Date: Mon, 12 Dec 2022 11:31:10 -0500 Subject: [PATCH 1/2] doc(replay): contributing note rrweb bump --- packages/replay/CONTRIBUTING.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 packages/replay/CONTRIBUTING.md diff --git a/packages/replay/CONTRIBUTING.md b/packages/replay/CONTRIBUTING.md new file mode 100644 index 000000000000..7a4656f211f8 --- /dev/null +++ b/packages/replay/CONTRIBUTING.md @@ -0,0 +1,5 @@ +## Updating the rrweb dependency + +When [updating the dependency](https://github.com/getsentry/sentry-javascript/blob/a493aa6a46555b944c8d896a2164bcd8b11caaf5/packages/replay/package.json#LL55), +please be aware that in [addition to this module's README.md](https://github.com/getsentry/sentry-javascript/blob/a493aa6a46555b944c8d896a2164bcd8b11caaf5/packages/replay/README.md#L204), +Sentry docs [point to a specific version of rrweb](https://github.com/getsentry/sentry-docs/blob/d6adadffc9e468ba777ccc733e69c373181237c9/src/platforms/javascript/common/session-replay/configuration.mdx#LL49) to refer to configuration which also need to be updated. From 603c276a2b4860359ec5db69afcd0b8865ec9e4d Mon Sep 17 00:00:00 2001 From: Bruno Garcia Date: Mon, 12 Dec 2022 12:58:46 -0500 Subject: [PATCH 2/2] Apply suggestions from code review Co-authored-by: Billy Vong --- packages/replay/CONTRIBUTING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/packages/replay/CONTRIBUTING.md b/packages/replay/CONTRIBUTING.md index 7a4656f211f8..ad2cb89e36b8 100644 --- a/packages/replay/CONTRIBUTING.md +++ b/packages/replay/CONTRIBUTING.md @@ -1,5 +1,5 @@ ## Updating the rrweb dependency -When [updating the dependency](https://github.com/getsentry/sentry-javascript/blob/a493aa6a46555b944c8d896a2164bcd8b11caaf5/packages/replay/package.json#LL55), -please be aware that in [addition to this module's README.md](https://github.com/getsentry/sentry-javascript/blob/a493aa6a46555b944c8d896a2164bcd8b11caaf5/packages/replay/README.md#L204), -Sentry docs [point to a specific version of rrweb](https://github.com/getsentry/sentry-docs/blob/d6adadffc9e468ba777ccc733e69c373181237c9/src/platforms/javascript/common/session-replay/configuration.mdx#LL49) to refer to configuration which also need to be updated. +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.