Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Some minor README cleanup #1649

Closed
wants to merge 2 commits into from
Closed

Some minor README cleanup #1649

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8c456e1
Some minor README cleanup
Feb 6, 2025
dcbd98d
Use active voice.
Feb 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -56,19 +56,19 @@ 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)

1. Fork this repository.
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.

Expand Down
Loading