Skip to content

Commit Message Guidelines

Aaditya Menon edited this page Dec 8, 2018 · 2 revisions

Git Commit Message Style Guide

Meaningful commit messages are crucially important as they provide information about what a commit does.

Commit Messages

Message Structure

Please write commit messages in the format mentioned below.

Divide the commit message into two parts - type and subject as shown below.

[type] subject

The Type The type can be one of these types:

  • feat: a new feature
  • fix: a bug fix
  • docs: changes to documentation
  • style: formatting, missing semi-colons, etc; no code change
  • refactor: refactoring production code
  • test: adding tests, refactoring test; no production code change
  • chore: updating build tasks, package manager configs, etc; no production code change

The Subject

The subject describes the commit in a sentence.

Clone this wiki locally