🙌 Thanks for wanting to contribute to Waffles, contributions are always welcome! 🙌
- Check out the PR template to see the full list of expectations that must be satisfied before merging into master. It can be helpful to open a draft PR in order to check off these items while the branch is still in progress.
- Format commit messages to follow the conventional commits standard. This is used to generate the changelogs when publishing packages.
- Split commits by package and functionality to make changelogs easier to interpret. If a PR covers multiple packages, fixes, refactors etc. then it should be split so a single commit only covers one of the above.
- Open a PR and wait for all the necessary reviews
- Merge the PR into the master branch
- Pull master onto your local machine
- Execute the publish script by running
yarn publish-packages
This will require an active npm login with sufficient permissions on the relevant packages. If you do not have this, or would just prefer somebody else to take care of the deployment, simply mention this on the PR. We're always happy to help.