conventional-changelog/commitlint

Custom error message if commit format is wrong.

Open

#3,165 创建于 2022年5月9日

在 GitHub 查看
 (10 评论) (1 反应) (0 负责人)TypeScript (15,497 star) (896 fork)batch import
featurehelp wanted

描述

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!

贡献者指南

技术栈
typescriptnodejs
领域
clitooling
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
mostly clear
前置要求
basic Node.jsunderstanding of commitlint
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
75
研究方向
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.