title |
---|
Contributing |
- report a issue
- assign issue to you
- create a draft pull request with the issue number included
- pass CI checking
- change the status of PR to "Ready for review"
- more than 3 members review and approve
- merge PR
Please read code-style.md
branch naming is kebab-case and require prefix in one of follow type
- feature: this PR introduces a new feature to the codebase
- fix: this PR patches a bug in codebase
- refactor: this PR changes the code base without new features or bugfix
- ci: this PR changes build/testing/ci steps
- docs: this PR changes the documents
- chore: this PR only has small changes that no need to record, like coding styles
git branch name example: chore/ci-add-typo-checking
[branch_name](#issue_number): commit message
git commit message example: [chore/ci-add-typo-checking](#1): CI add typos cli tools to check typo