- Node.js 18+ (LTS/Hydrogen recommended)
- pnpm 9.12.0
- Rush 5.14.0
- Install Node.js 18+
nvm install lts/hydrogen
nvm alias default lts/hydrogen # set default node version
nvm use lts/hydrogen- Clone the repository
git clone git@github.com:coze-dev/cozeloop-js.git- Install required global dependencies
npm i -g pnpm@9.12.0 @microsoft/rush@5.14.0- Install project dependencies
rush updateAfter that, you can start to develop projects inside this repository.
-
Create a new branch from
mainusing the format:feat/descriptionfor featuresfix/descriptionfor bug fixesdocs/descriptionfor documentationchore/descriptionfor maintenance
-
Write code and tests
- Follow our coding standards
- Add/update tests for changes
- Update documentation if needed
-
Ensure quality
- Run
cd path/to/packageName && rushx testfor all tests - Run
rush lintfor code style - Run
rush buildto verify build
- Run
-
Create Pull Request
- Use the PR template
- Link related issues
- Provide clear description of changes
-
Review Process
- Maintainers will review your PR
- Address review feedback if any
- Changes must pass CI checks
-
Commit Message Format
type(scope): subject bodyTypes: feat, fix, docs, style, refactor, test, chore
Report bugs via GitHub Issues. Please include:
- Issue description
- Steps to reproduce
- Expected behavior
- Actual behavior
- Code examples (if applicable)
- Update API documentation for interface changes
- Update README.md if usage is affected
This project is under the MIT License. By submitting code, you agree to these terms.