- We use Conventional Commits style of commit messages.
- On opening a new PR, the comments will guide you on how to construct the new PR.
- Pull requests are squashed and merged onto the
main
branch. - PR title is used as commit's first line, PR description is used as commit body.
- Add tests whenever possible.
- Approve pull requests before merging.
- Enforce conventional commits before merging pull requests.
- A commit's first line should be formatted as
<type>[optional scope]: <description>
. - A commit's body should have a description of changes in bullet points followed by any links it references or issues it fixes or closes.
- NPM Publish Action publishes to
npm
if there is a version bump.