conventional-changelog/commitlint

Custom error message if commit format is wrong.

Open

#3,165 opened on May 9, 2022

View on GitHub
 (10 comments) (1 reaction) (0 assignees)TypeScript (896 forks)batch import
featurehelp wanted

Repository metrics

Stars
 (15,497 stars)
PR merge metrics
 (Avg merge 12h 56m) (52 merged PRs in 30d)

Description

The idea is pretty simple. If someone commits the first time to a new repo with commitlint the most common error is that the commitmsg was wrong. In our case we have a npm run commit that triggers the cz-cli. So I would like to add a custom error message for this case that the programmer can use npm commit. Thanks!

Contributor guide

Research direction
Look into the commitlint configuration to allow customization of the error message when commit format is invalid. Check if there's an existing option or if a new one needs to be added. Consider the cz cli integration and how to prompt the user to use `npm run commit` instead.
Tech stack
typescript
Domain
clitooling
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
Gitcommitlintcz cli
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75