From 8c456e1c71a80216ed184900bf0ab1497140b054 Mon Sep 17 00:00:00 2001 From: BLorettePop <197973857+BLorettePop@users.noreply.github.com> Date: Thu, 6 Feb 2025 01:37:16 +0000 Subject: [PATCH 1/2] Some minor README cleanup --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index e73c2a8768..3cb1531c5a 100644 --- a/README.md +++ b/README.md @@ -39,9 +39,9 @@ rrweb is mainly composed of 3 parts: ## Roadmap -- storage engine: do deduplication on a large number of rrweb sessions -- compact mutation data in common patterns -- provide plugins via the new plugin API, including: +- Storage engine: do deduplication on a large number of rrweb sessions +- Compact mutation data in common patterns +- Provide plugins via the new plugin API, including: - XHR plugin - fetch plugin - GraphQL plugin @@ -64,11 +64,11 @@ Since we want the record and replay sides to share a strongly typed data structu 2. Run `yarn install` in the root to install required dependencies for all sub-packages (note: `npm install` is _not_ recommended). 3. Run `yarn build:all` to build all packages and get a stable base, then `yarn dev` in the root to get auto-building for all the sub-packages whenever you modify anything. 4. Navigate to one of the sub-packages (in the `packages` folder) where you'd like to make a change. -5. Patch the code and run `yarn test` to run the tests, make sure they pass before you commit anything. Add test cases in order to avoid future regression. -6. If tests are failing, but the change in output is desirable, run `yarn test:update` and carefully commit the changes in test output. +5. Patch the code and run `yarn test` to run the tests. Make sure the tests pass before commiting code. Add test cases in order to avoid future regressions. +6. If tests are failing - but the change in output is desirable - run `yarn test:update` and carefully commit the changes in test output. 7. Push the code and create a pull request. -Protip: You can run `yarn test` in the root folder to run all the tests. +**Protip:** You can run `yarn test` in the root folder to run all the tests. In addition to adding integration tests and unit tests, rrweb also provides a REPL testing tool. From dcbd98def1f91e31efb436ec71b6a40be179739c Mon Sep 17 00:00:00 2001 From: BLorettePop <197973857+BLorettePop@users.noreply.github.com> Date: Thu, 6 Feb 2025 01:58:10 +0000 Subject: [PATCH 2/2] Use active voice. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 3cb1531c5a..b0daff52a3 100644 --- a/README.md +++ b/README.md @@ -56,7 +56,7 @@ rrweb is mainly composed of 3 parts: ## Contribute Guide -Since we want the record and replay sides to share a strongly typed data structure, rrweb is developed with typescript which provides stronger type support. +Rrweb is developed with Typescript so that both the recording and replay components of the application share a strongly typed data structure. [Typescript handbook](https://www.typescriptlang.org/docs/handbook/declaration-files/introduction.html)