Skip to content

Latest commit

 

History

History
41 lines (36 loc) · 929 Bytes

CONTRIBUTING.md

File metadata and controls

41 lines (36 loc) · 929 Bytes

Contributing

This is a guide for contributors.

How to dev

  • npm run build: Build for production
  • npm run lint: Run static-checking
  • npm run test: Run tests
  • npm run update-api-docs: Update API documentation

How to release

  • Wait for passing CI...
  • git switch main && git pull
  • rm -rf dist && npm run build
  • npm version <major|minor|patch>
    • If you want to release a pre-release version, use the following command instead:
      npm version <premajor|preminor|prepatch> --preid=<alpha|beta>
    • If you want to update the pre-release version, use the following command instead:
      npm version prerelease
  • npm publish
    • If you want to publish a pre-release version, use the following command instead:
      npm publish --tag=<alpha|beta>
  • git push --follow-tags