Skip to content

Latest commit

 

History

History
41 lines (24 loc) · 1.13 KB

File metadata and controls

41 lines (24 loc) · 1.13 KB

Commit Message Guidelines

source: link

<type>(<scope>): MESSAGE

[optional body]

[optional footer]

Types

  • feat: A new feature
  • fix: A bug fix
  • docs: Documentation only changes
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • refactor: A code change that neither fixes a bug nor adds a feature
  • perf: A code change that improves performance
  • test: Adding missing or correcting existing tests
  • chore: Changes to the build process or auxiliary tools and libraries such as documentation generation

Scope

The scope should be the name of the module affected

Message

The message should be a short description of the change, written in the imperative mood.

Body

The body should include the motivation for the change and contrast this with previous behavior.

Footer

The footer should contain any information about breaking changes and is also the place to reference GitHub issues that this commit closes/addresses.