From dbd22cd7de5819eee58ad0e9b5bc6a885a352606 Mon Sep 17 00:00:00 2001 From: archergu <649601376@qq.com> Date: Tue, 11 Mar 2025 09:08:43 +0800 Subject: [PATCH] docs: update CONTRIBUTING.md --- CONTRIBUTING.md | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5706fae7..0e2b3543 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,15 +3,21 @@ ## Making changes 1. Fork the repository. -2. Make changes. -3. Add tests in `test/`. -4. Run tests with `pnpm test`. +2. Checkout a new branch from main. +3. Make changes. +4. If necessary, add tests in `test/`. +5. Run tests with `pnpm test`. +6. Commit changes and push to your fork. +7. Create a pull request. ## 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. +> Only maintainers can release new versions. + +1. Merge PRs into main branch. +2. Change version in `package.json`. +3. Push main branch to remote with `git push`. +4. Create a new tag and push it to remote. +5. GitHub action will create a release and publish it to npm. Feel free to improve this process by creating an issue or PR.