> For the complete CircleCI developer hub index, see [llms.txt](https://circleci.com/developer/llms.txt)

# conventional-changelog/commitlint

commitlint helps your team adhere to a standard commit convention. Add commit message linting to your CI process to prevent non-standard commit messages from being merged, and provide contrinbutors with details for resolving their PR.


## Jobs

### lint

Add this lint job to your workflow to easily enable commit message lint checking as a step in your CI process.


| Parameter | Type | Default | Description |
|---|---|---|---|
| `config-path` | string | ./commitlint.config.js | Path to commitlint config file |
| `configs` | string | @commitlint/config-conventional | A space-separated list of commitlint config packages to install. |
| `max-count` | integer | 10 | The maximum number of commits to lint. |
| `node-version` | string | 16.5.0 | Specify the NodeJS version used to run the commitlint job. This should not usually need to be changed. |
| `target-branch` | string | main | Commits in the current branch will be compared against the target branch for linting. All commits not present in the target branch will be linted. |

## Examples

### lint_all_commits

Add the `commitlint/lint` job to your existing workflow to quickly and easily begin linting your commit mesages.
Ensure you have first added your `commitlint.config.js` file to your project.


```yaml
version: '2.1'
orbs:
  commitlint: conventional-changelog/commitlint@1.0
workflows:
  my-workflow:
    jobs:
      - commitlint/lint
```