Skip to content

Latest commit

 

History

History

commitlint-config

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
src
src
 
 
README.md
README.md
 
 
package.json
package.json
 
 
tsconfig.json
tsconfig.json
 
 

README.md

@lobehub/commitlint-config

Commitlint configuration for LobeHub projects

Features

  • Gitmoji commit convention
  • Enforces consistent commit message format
  • Compatible with semantic-release

Installation

pnpm add -D @lobehub/commitlint-config @commitlint/cli

Usage

Create commitlint.config.js (or .commitlintrc.js) in your project root:

import config from '@lobehub/commitlint-config';

export default config;

Or for CommonJS:

module.exports = require('@lobehub/commitlint-config').default;

Commit Format

:emoji: type(scope): subject

body

footer

Examples

:sparkles: feat(auth): add OAuth2 support

Implement OAuth2 authentication flow with Google and GitHub providers.

Closes #123

:bug: fix(api): resolve race condition in data fetching

:memo: docs: update installation guide

Setting Up Git Hooks

With Husky:

pnpm add -D husky
pnpm husky init
echo "pnpm commitlint --edit \$1" > .husky/commit-msg

Requirements

  • Node.js >= 18
  • @commitlint/cli >= 19.0.0

License

MIT © LobeHub