Skip to content

AlejandroSuero/go-commitlint

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Stargazers Issues

Commit linter in Go

A commit linter based on conventional commits rules written in Go.

What is commitlint?

Commitlint is a tool to help you maintain a conventional commit message style in your project.

General pattern:

type(scope): subject # scope is optional

Examples:

feat(commits): add filtering by scope
fix: fix typo in README
docs: add documentation for new features
feat!: add new breaking change feature

Common types according to the conventional commits specification:

  • feat: A new feature
  • fix: A bug fix
  • docs: Documentation only changes
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • refactor: A code change that neither fixes a bug nor adds a feature
  • perf: A code change that improves performance
  • test: Adding missing tests or correcting existing tests
  • 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)
  • chore: Other changes that don't modify src or test files

About

Commit linter following conventional commits rules

Resources

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

 

Packages

No packages published