xuguopeng/rrweb
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Create CONTRIBUTING.md (#969)

Browse Source
This commit is contained in:
Justin Halsall
2026-04-01 12:00:00 +08:00
committed by GitHub
parent fa1e251e2b
commit f6b292975f
1 changed files with 25 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
CONTRIBUTING.md Normal file
View File

@@ -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.