@gradient-network/commitlint-config

Commitlint configuration shared for Gradient Network.

Guidelines

Learn more: Conventional Commits

Type

Must be one of the following:

• build: Changes that affect the build system or external dependencies
• ci: Changes to our CI configuration files and scripts
• docs: Documentation (include comments) only changes
• feat: A new feature
• fix: A bug fix
• perf: A code change that improves performance
• refactor: A code change that neither fixes a bug nor adds a feature
• style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
• test: Adding missing tests or correcting existing tests
• chore: Changes to miscellaneous things
• revert: The commit reverts a previous commit

Usage

Install the package into your project.

pnpm add -D @gradient-network/commitlint-config

Reference in your package.json by adding the field commitlint.

Learn more: Shareable configurations

{
  "commitlint": {
    "extends": ["@gradient-network/commitlint-config"]
  }
}

Pre-commit Hook

Work with the git hook pre-commit, you need install husky.

Edit the file .husky/commit-msg and add the command.

commitlint