Contributions are welcome! Feel free to submit a pull request or open an issue if you have any suggestions or feedback.
This project follows the Contributor Covenant Code of Conduct and the Conventional Commits Specification.
From the Conventional Commits Specification Summary:
The commit message should be structured as follows:
{type}[optional scope]: {description}
[optional body]
[optional footer(s)]
Where type is one of the following:
| Type | Description | Example Commit Message |
|---|---|---|
fix |
Patches a bug in your codebase (correlates with PATCH in Semantic Versioning) | fix: correct typo in README |
feat |
Introduces a new feature to the codebase (correlates with MINOR in Semantic Versioning) | feat: add new user login functionality |
BREAKING CHANGE |
Introduces a breaking API change (correlates with MAJOR in Semantic Versioning) | feat!: drop support for Node 8 |
build |
Changes that affect the build system or external dependencies | build: update dependency version |
chore |
Other changes that don't modify src or test files | chore: update package.json scripts |
ci |
Changes to CI configuration files and scripts | ci: add CircleCI config |
docs |
Documentation only changes | docs: update API documentation |
style |
Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc.) | style: fix linting errors |
refactor |
Code change that neither fixes a bug nor adds a feature | refactor: rename variable for clarity |
perf |
Code change that improves performance | perf: reduce size of image files |
test |
Adding missing tests or correcting existing tests | test: add unit tests for new feature |