Skip to content

Latest commit

 

History

History
31 lines (21 loc) · 1.05 KB

git.md

File metadata and controls

31 lines (21 loc) · 1.05 KB

GIT

Specifications for adding human- (and machine-) readable meaning to GIT commit messages.

TL;DR

The commit message should be structured as follows:

<type>[optional scope]: <short description>

[optional long description(s)]

[optional specification(s)]

Follow guidelines in Conventional Commits.

Type

  • build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
  • ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
  • docs: Documentation only changes
  • feat: A new feature
  • fix: A bug fix
  • perf: A code change that improves performance
  • refactor: A code change that neither fixes a bug nor adds a feature
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • test: Adding missing tests or correcting existing tests

Use a bang ! after type to draw attention, e.g., to breaking change.