Files

Eoghan Murray 26c331b3b7 yarn format - prettier improvements & add .editorconfig (#1471 )

Some dev improvements:
* Add .editorconfig config file https://editorconfig.org/
* move the singleQuote spec into .editorconfig and add old .changesets/*.md to .prettierignore so that we don't incorrectly reformat new changeset files to single quote from the double quote which they can be autogenerated with in github
* .gitignore Ignore emacs chaff files
* Add `yarn format:head` a convenience command to run prettier against just those files in the head commit
* Some mention of `yarn format` in the docs
* Fix some test html closing tags; authoring mistakes, rather than deliberately malformed html — picked up by an explicit `yarn prettier --write '**/*.html'`

2024-05-13 11:53:08 +01:00

1.6 KiB

Raw Blame History

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.

Pull Requests

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.

Issues

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.

Run locally

Install dependencies: yarn
Run recorder on a website: yarn repl
Run a cobrowsing/mirroring session locally: yarn live-stream
Test: yarn test or yarn test:watch
Lint: yarn lint
Rewrite files with prettier: yarn format or yarn format:head

Coding style

See documentation

License

rrweb is MIT licensed.

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

1.6 KiB Raw Blame History