If you encounter what you believe is a bug, please report an issue. For suggesting new features, you should first start a discussion if one does not already exist. Feel free to also join and comment on existing discussions.
To contribute by resolving an open issue or developing a new feature, please adhere to the following workflow:
- Fork this repository.
- Create a new feature branch from the
mainbranch. - (tip) Run the
pnpm devto start a local dev-server for the docs/examples/benchmarking app - Stage your changes and commit them. We recommend following the Conventional Commit Specification for commit messages.
- Make sure all the tests pass when running
pnpm test. - Submit the PR for review.
After your pull request is submitted, we will review it at as soon as possible. We may suggest changes or request additional improvements, so please enable Allow edits from maintainers on your PR.
- Create new branch, update version string in package.json, run
pnpm install - Take the Continuous Release build and test the changes on StackBlitz (optional)
- Merge to main
- Prepare the package for publishing
cd packages/typegpu
pnpm publish --dry-run # (if alpha, --tag alpha)- If everything looks okay, then
pnpm publish(if alpha,--tag alpha)
Tip: If you already know all prepublish checks pass (tests, types, publish tag validation), you can skip them to speed up publishing:
SKIP_TESTS=true pnpm publish # (if alpha, --tag alpha)
- Rebase release branch on main
- Generate and edit release notes on GitHub
- Run
npx automd@latest