How to Contribute

We'd love to accept your contributions to this project. Here are a few small guidelines you must follow.

Commit Messages

We follow the Conventional Commits specification to help keep the commit history readable and to automate release process & changelogs.

The commit messages should be lower-case and follow this format:

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

We allow the type chore, fix, feat, and BREAKING CHANGE only:

chore: a commit of the type chore indicates a change which has no effect on the end user (this type does not increment the version).
fix: a commit of the type fix patches a bug in your codebase (this correlates with PATCH in semantic versioning).
feat: a commit of the type feat introduces a new feature to the codebase (this correlates with MINOR in semantic versioning).
BREAKING CHANGE: a commit that appends a ! after the type/scope and optionally has a footer BREAKING CHANGE:, introduces a breaking change (correlating with MAJOR in semantic versioning).

Commits of any type can be a BREAKING CHANGE.

Refer to the specification for more information.

All submissions, including submissions by project members, require review.