Skip to content

Instantly share code, notes, and snippets.

@bndynet

bndynet/commit_message_style_guide.md

Last active November 21, 2020 23:26
Show Gist options
  • Star 1 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save bndynet/283e26eed86d9e0f005e5ad7bd1e69f3 to your computer and use it in GitHub Desktop.
Save bndynet/283e26eed86d9e0f005e5ad7bd1e69f3 to your computer and use it in GitHub Desktop.
Download ZIP
Commit Message Style Guide
Raw
commit_message_style_guide.md

Recommendation for Git Commit Message

The Type

The type is contained within the title and 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

Subjects should be no greater than 50 characters, should begin with a capital letter and do not end with a period.

Use an imperative tone to describe what a commit does, rather than what it did. For example, use change; not changed or changes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment