Skip to content

Commit

Permalink
docs: Contribution guide (#854)
Browse files Browse the repository at this point in the history
  • Loading branch information
mhawryluk authored and iwoplaza committed Feb 14, 2025
1 parent b1dca42 commit 74a4a68
Showing 1 changed file with 35 additions and 0 deletions.
35 changes: 35 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Contributing

## Reporting Issues and Suggesting Features
If you encounter what you believe is a bug, please [report an issue](https://github.com/software-mansion/TypeGPU/issues/new). For suggesting new features, you should first [start a discussion](https://github.com/software-mansion/TypeGPU/discussions/new/choose) if one does not already exist. Feel free to also join and comment on [existing discussions](https://github.com/software-mansion/TypeGPU/discussions).


## Development

To contribute by resolving an open issue or developing a new feature, please adhere to the following workflow:

1. Fork this repository.
2. Create a new feature branch from the `main` branch.
3. Ensure that the `pnpm dev` script is running at all times during development.
4. Stage your changes and commit them. We recommend following the [Conventional Commit Specification](https://www.conventionalcommits.org/en/v1.0.0/) for commit messages.
5. Make sure all the tests pass when running `pnpm test`.
6. 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](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) on your PR.


## Release Checklist

1. Create new branch, update version string in package.json and in openInStackBlitz.ts, run `pnpm install`
2. Take the built package from code sandbox CI and test the changes on StackBlitz (optional)
3. Merge to main
4. Prepare the package for publishing
```bash
cd packages/typegpu
pnpm prepare-package
cd dist
pnpm publish -—dry-run # (if alpha, --tag alpha)
```
5. If everything looks okay, then `pnpm publish` (if alpha, `--tag alpha`)
6. Rebase *release* branch on *main*
7. Generate and edit release notes on GitHub

0 comments on commit 74a4a68

Please sign in to comment.