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.