conventional-changelog/commitlint

Rule does not work with #ids

Open

#3,615 创建于 2023年5月31日

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

描述

I was trying this utility in my project as we are planning to enforce conventional commit messages. It works nicely but I was pleasantly surprised when it started failing miserably. When I tried to commit with messages like git commit -m "#123 - test commit" it does not throw any error. However when I run commitlint --from=HEAD~1 it shows error.

Screenshot 2023-05-31 at 14 34 20

This is causing issues as the team is accustomed to #ticket-id - message pattern.

贡献者指南

技术栈
typescriptnodejsshell
领域
clideveloper experiencetooling
议题类型
bug
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
active
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
conventional commitscommitlint configurationregex basics
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
40
研究方向
Investigate how commitlint's parser handles commit messages that start with '#' (e.g., '#123 message'). The bug likely lies in the parsing logic that treats '#' as a comment or ignores it. Check the `@commitlint/parse` package and the conventional changelog parser. Look for tests related to subject line parsing and consider adding support for common patterns like '#ticket message'. Review comments in issue #3615 for additional context.
Rule does not work with #ids · conventional-changelog/commitlint#3615 | Good First Issue