Skip to content

Commit e9ee083

Browse files
egoistsxzz
authored andcommitted
docs: CONTRIBUTING.md
1 parent 048c93b commit e9ee083

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

CONTRIBUTING.md

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Contributing
2+
3+
## Making changes
4+
5+
1. Fork the repository.
6+
2. Make changes.
7+
3. Add tests in `test/`.
8+
4. Run tests with `pnpm test`.
9+
10+
## Release changes
11+
12+
1. Merge PRs into dev branch.
13+
2. Merge dev branch into main branch with `git checkout main && git merge dev`
14+
3. Push main branch to remote with `git push`
15+
4. GitHub action will create a release and publish it to npm.
16+
17+
Feel free to improve this process by creating an issue or PR.

0 commit comments

Comments
 (0)