From f6b292975f6d1cdaf277c4a3aa5d98f2c82b45b7 Mon Sep 17 00:00:00 2001 From: Justin Halsall Date: Wed, 1 Apr 2026 12:00:00 +0800 Subject: [PATCH] Create CONTRIBUTING.md (#969) --- CONTRIBUTING.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..5ae2f1e1 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,25 @@ +# 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. +1. Fork the repo and create your branch from `master`. +2. If you've added code that should be tested, add tests +3. If you've changed APIs, update the documentation. +4. Ensure the test suite passes. +5. 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. + +## License +rrweb is [MIT licensed](https://github.com/rrweb-io/rrweb/blob/master/LICENSE). + +By contributing to rrweb, you agree that your contributions will be licensed +under its MIT license.