conventional-changelog/commitlint

Rule does not work with #ids

开放

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

在 GitHub 查看贡献者指南
 (12 条评论) (0 个反应) (0 位负责人)TypeScript (896 个派生)batch import
bughelp wanted

仓库指标

星标
 (15,497 个星标)
PR 合并指标
 (PR 指标待抓取)

描述

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.

贡献者指南

研究方向
研究 commitlint 的解析器如何处理以 '#' 开头的提交消息（例如 '#123 message'）。问题可能出在将 '#' 视为注释或忽略它的解析逻辑上。检查 `@commitlint/parse` 包和 conventional changelog 解析器。查找与主题行解析相关的测试，并考虑添加对常见模式（如 '#ticket message'）的支持。查看 issue #3615 中的评论以获取更多上下文。
技术栈
typescriptnodejs
领域
clitooling
议题类型
缺陷
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 小时
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
GitNode.js
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
65