Semantic Commit

Type and description of commits, which highlight exactly what was changed in the code.

Star Fork

Problem

Working in teams, each writing their way, the history of commits tend to turn into a mess.

➜ git log --pretty=oneline
29d5g2 (tag: 0.3.0) add new awesome feature
6das1n  fix
n3282e (tag: 0.2.3) bump version
b2h4vs  resolve conflict
43h43b  merge with branch BugFixTitle

Solution

A command line interface that establishes types of commits, and expects a concise description of who is doing the commit.

➜ semantic-commit
? Choose the type of the commit: (Use arrow keys)
  chore
  docs
  feat
> fix
  refactor
  style
  test
? Write the commit message: urls http to https

Pattern

With this we have a standard of commits, and it is much more easy localized when and how changes in the code were made in the commits history.

➜ git log --pretty=oneline
29d5g2 (tag: 2.5.1) fix: broken links on home
29d5g2  doc: update docs with new payment
29d5g2  test: new payment, unit and e2e
29d5g2 (tag: 2.5.0) feat: new form of payment
d5a4sd (tag: 2.4.1) fix: duplicate page title

Install

To use, just install the package with your favorite dependency manager.

# using yarn run
➜ yarn global add semantic-commit
# using npm run
➜ npm i -g semantic-commit