Contributing to rrweb

We want to make contributing to this project as easy and transparent as possible.

Our Development Process

The majority of development on rrweb will occur through GitHub. Accordingly, the process for contributing will follow standard GitHub protocol.

We actively welcome your pull requests (PRs)!

Fork the repo and create your branch from master.
If you've added code that should be tested, add tests
Ensure the test suite passes or ask for help as to why tests are failing
We use changesets to enable you to easily document your PR so that it can be packaged up into the next release. A github plugin will prompt you to fill in your changeset if you haven't already done so.
If you've changed APIs, update the documentation.
Make sure your code lints and typechecks.

We use GitHub issues to track public bugs. Please ensure your description is clear and has sufficient instructions to be able to reproduce the issue.

Install dependencies: yarn
Build all packages: (in /) yarn build:all or yarn dev
Run recorder on a website: (in /packages/rrweb) yarn repl
Run a cobrowsing/mirroring session locally: (in /packages/rrweb) yarn live-stream
Build individual packages: yarn build or yarn dev
Test: yarn test or yarn test:watch
Lint: yarn lint
Rewrite files with prettier: yarn format or yarn format:head

By contributing to rrweb, you agree that your contributions will be licensed under its MIT license.