Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
29 lines (16 loc) · 1.61 KB

CONTRIBUTING.md

File metadata and controls

29 lines (16 loc) · 1.61 KB

How to contribute to this project

Commits

This project uses standard-version, which depends on [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) rules, for versions and change logs management.

In this case your commit message should be structured as follows:

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

Common commit structural elements are:

  1. fix: a commit of the type fix patches a bug in your codebase (this correlates with PATCH in semantic versioning).

  2. feat: a commit of the type feat introduces a new feature to the codebase (this correlates with MINOR in semantic versioning).

  3. BREAKING CHANGE: a commit that has a footer BREAKING CHANGE:, or appends a ! after the type/scope, introduces a breaking API change (correlating with MAJOR in semantic versioning). A BREAKING CHANGE can be part of commits of any type.

  4. types other than fix: and feat: are allowed, for example [@commitlint/config-conventional](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional) (based on the the Angular convention) recommends build:, chore:, ci:, docs:, style:, refactor:, perf:, test:, and others.

  5. footers other than BREAKING CHANGE: <description> may be provided and follow a convention similar to git trailer format.

Here is some commit message examples.