# commitlint

Entermedia uses commitlint to organize and standarize commit messages which helps with:

• Automatically generating a CHANGELOG
• Automatically determining a semantic version bump (based on the types of commits landed).
• Communicating the nature of changes to teammates, the public, and other stakeholders
• Triggering build and publish processes
• Making it easier for people to contribute to your projects, by allowing them to explore a more structured commit history.

Commit messages should follow this format:

type(scope?): subject  #scope is optional; multiple scopes are supported (current delimiter options: "/", "" and ",")

Real world examples can look like this:

"chore: run tests on travis ci"
"fix(server): send cors headers"
"feat(blog): add comment section"

Common types according to commitlint-config-conventional (based on the Angular convention) can be:

• build
• chore
• ci
• docs
• feat
• fix
• perf
• refactor
• revert
• style
• test

Install commitlint and commitlint-config-conventional, then configure commitlint to use it.

npm install --save-dev commitlint @commitlint/config-conventional
echo "module.exports = { extends: ['@commitlint/config-conventional'] };" > commitlint.config.js

Install husky as a devDependency, a handy git hook helper available on npm.

npm install husky --save-dev # Install Husky
npx husky install # Activate hooks
npx husky add .husky/commit-msg 'npx --no -- commitlint --edit $1' # Add hook