@commitlint/travis-cli

Get Started | Website

Lint commit messages

<p align="center" <img width="600" src="docs/public/assets/commitlint.svg" </p

Demo generated with svg-term-cli cat docs/assets/commitlint.json | svg-term --out docs/public/assets/commitlint.svg --frame --profile=Seti --height=20 --width=80

• 🚓 Be a good commitizen
• 📦 Share configuration via npm
• 🤖 Tap into conventional-changelog

Contents

• Get Started | Website
• Contents
• What is commitlint
• Benefits of using commitlint
• Getting started
• CLI

• Config
• Shared configuration
• Documentation
• API
• Tools
• Roadmap

• Version Support and Releases
• Releases
• Related projects
• License
• Development
• Install and run

---

What is commitlint

commitlint checks if your commit messages meet the conventional commit format.

In general the pattern mostly looks like this:

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