conventional-changelog/commitlint

Custom error message if commit format is wrong.

Open

#3165 opened on May 9, 2022

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

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

Tech stack
typescriptnodejs
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
basic Node.jsunderstanding of commitlint
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
Review the commitlint source code to find where commit format errors are currently handled. Look at the error output logic and consider how to add a custom message that suggests using 'npm run commit' if the commit format is wrong. Check the issue comments for any implementation hints. Files like 'cli.js' or 'lint.js' may be relevant.