docs: CONTRIBUTING.md

This commit is contained in:
EGOIST 2024-07-22 16:43:55 +08:00 committed by 三咲智子 Kevin Deng
parent 048c93b346
commit e9ee08314e
No known key found for this signature in database

17
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,17 @@
# Contributing
## Making changes
1. Fork the repository.
2. Make changes.
3. Add tests in `test/`.
4. Run tests with `pnpm test`.
## Release changes
1. Merge PRs into dev branch.
2. Merge dev branch into main branch with `git checkout main && git merge dev`
3. Push main branch to remote with `git push`
4. GitHub action will create a release and publish it to npm.
Feel free to improve this process by creating an issue or PR.