From e9ee08314ea4231c907e2cc3840b8e4dd543f1b7 Mon Sep 17 00:00:00 2001 From: EGOIST <0x142857@gmail.com> Date: Mon, 22 Jul 2024 16:43:55 +0800 Subject: [PATCH] docs: CONTRIBUTING.md --- CONTRIBUTING.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..5706fae79 --- /dev/null +++ b/CONTRIBUTING.md @@ -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.