Refer to the GiHub Flow rules for more details, but in short:
- Fork the proyect and create a PR to the original one when you are done
- Always create the changes in a feature branch, using a descriptive name for the change
- Provide a short but descriptive message in your commits, they will be all squashed into one once the branch gets merged
- Never push to master or develop
- Update your local development branch with
git pull --rebase origin develop - Always provide unit tests for your changes if applicable
npm ito build and install all inner dependencies- Make the neecessary changes
- Follow the guide in
samples/README.mdto start the example project - Test your changes agains it
Before get your hands down to code please open an issue describing your idea, or refer to our Discord chat
Make sure to follow the PR template
- Squash all your commits into one, following the conventional commits guide