这是indexloc提供的服务，不要输入任何密码
Skip to content

docs: update CONTRIBUTING.md #1317

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: update CONTRIBUTING.md #1317

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 13 additions & 7 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.