Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
37 lines (26 loc) · 745 Bytes

CONTRIBUTING.md

File metadata and controls

37 lines (26 loc) · 745 Bytes

Contributing

Thanks for contributing to @hypershub/sdk.

Development

Requirements:

  • Node.js 20+
  • npm

Setup:

git clone git@github.com:simonguo/typescript-sdk.git
cd typescript-sdk
npm install

Run checks locally:

npm run typecheck
npm test
npm run build

Release checklist

  1. Update package.json version.
  2. Update CHANGELOG.md.
  3. Run npm run typecheck && npm test && npm run build.
  4. Commit and tag the release.
  5. Create a GitHub Release for the tag, or manually run the Publish workflow.
  6. Verify with npm view @hypershub/sdk version.

Publishing uses npm Trusted Publisher with GitHub Actions OIDC. Do not add NPM_TOKEN unless you intentionally switch back to token-based publishing.