1.0.0 • Published 3 years ago

@tdsoft/commitlint-config v1.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
3 years ago

@tdsoft/commitlint-config

What is commitlint

Commitlint checks if your commit messages meet the specified requirements.

Format

<type>(<scope>): <subject>

<scope> is optional

Example

feat: introduce useClipboard hook

@tdsoft config

commit typeexample use case
choreall other cases - set staging API url
cici/cd related - update Jenkinsfile, Dockerfile
docschanges to the documentation
featadding new functionality
fixbug fixing
refactorrefactoring code - renaming variable
revertreverting commit
stylechanging styles without changing business logic
testupdating/adding test suites
versionbumping version tag

Note that in conventional commits' config "style" is used for code formatting. In this config, "style" is used for UI styling related commits that do not change business logic.

How to use this config

Use extends option in .commitlintrc.json

{
  "extends": ["@tdsoft"]
}