在commitlint中实现提交信息去重与规范校验的实践
2025-05-12 13:27:07作者:平淮齐Percy
在软件开发过程中,良好的Git提交信息规范对项目维护至关重要。conventional-changelog/commitlint作为流行的提交信息校验工具,虽然提供了强大的规则系统,但在某些特定场景下仍需要扩展功能。
提交信息重复问题分析
在实际开发中,我们经常会遇到重复提交的问题。例如:
feat: 添加节点代理
feat: 添加节点代理
feat: 添加节点代理
这类重复提交不仅污染提交历史,还会影响变更日志的生成质量。虽然commitlint本身不直接提供去重功能,但可以通过以下方案解决:
解决方案实现
通过简单的Shell脚本即可实现提交信息去重检查:
git log --pretty=format:%s $first_commit..$last_commit > ./subjects
duplicates="$(cat ./subjects | sort | uniq -D)"
if [ "$duplicates" != "" ]; then
echo -e "发现重复提交:\n$duplicates" >&2
exit 1
fi
该脚本会:
- 提取指定范围内的所有提交信息
- 使用sort和uniq命令找出重复项
- 发现重复时终止流程并输出错误
提交类型与内容匹配问题
另一个常见问题是提交类型与内容不匹配,例如:
feat(xxx): 重构xxx
正确的形式应该是:
refactor(xxx): xxx
或
feat(xxx): xxx
校验规则设计思路
虽然commitlint没有内置此规则,但可以通过以下方式实现:
- 创建自定义规则检查提交类型与内容关键词的匹配性
- 建立类型-关键词映射表(如feat对应"新增"、"添加"等)
- 当检测到不匹配时抛出错误
最佳实践建议
- 结合Git钩子:将校验脚本集成到pre-commit或pre-push钩子中
- CI/CD集成:在持续集成流程中加入校验步骤
- 团队规范:制定明确的提交信息编写指南
- 自动化工具:考虑使用commitizen等交互式工具辅助生成合规提交
通过以上措施,可以显著提升项目提交历史的质量,为自动化生成变更日志和版本管理打下良好基础。虽然部分功能需要自行扩展,但这正体现了Git工具链的灵活性和可定制性优势。
登录后查看全文
热门项目推荐
相关项目推荐
PaddleOCR-VL
PaddleOCR-VL 是一款顶尖且资源高效的文档解析专用模型。其核心组件为 PaddleOCR-VL-0.9B,这是一款精简却功能强大的视觉语言模型(VLM)。该模型融合了 NaViT 风格的动态分辨率视觉编码器与 ERNIE-4.5-0.3B 语言模型,可实现精准的元素识别。Python00- DDeepSeek-V3.2-ExpDeepSeek-V3.2-Exp是DeepSeek推出的实验性模型,基于V3.1-Terminus架构,创新引入DeepSeek Sparse Attention稀疏注意力机制,在保持模型输出质量的同时,大幅提升长文本场景下的训练与推理效率。该模型在MMLU-Pro、GPQA-Diamond等多领域公开基准测试中表现与V3.1-Terminus相当,支持HuggingFace、SGLang、vLLM等多种本地运行方式,开源内核设计便于研究,采用MIT许可证。【此简介由AI生成】Python00
openPangu-Ultra-MoE-718B-V1.1
昇腾原生的开源盘古 Ultra-MoE-718B-V1.1 语言模型Python00ops-transformer
本项目是CANN提供的transformer类大模型算子库,实现网络在NPU上加速计算。C++0126AI内容魔方
AI内容专区,汇集全球AI开源项目,集结模块、可组合的内容,致力于分享、交流。02Spark-Chemistry-X1-13B
科大讯飞星火化学-X1-13B (iFLYTEK Spark Chemistry-X1-13B) 是一款专为化学领域优化的大语言模型。它由星火-X1 (Spark-X1) 基础模型微调而来,在化学知识问答、分子性质预测、化学名称转换和科学推理方面展现出强大的能力,同时保持了强大的通用语言理解与生成能力。Python00GOT-OCR-2.0-hf
阶跃星辰StepFun推出的GOT-OCR-2.0-hf是一款强大的多语言OCR开源模型,支持从普通文档到复杂场景的文字识别。它能精准处理表格、图表、数学公式、几何图形甚至乐谱等特殊内容,输出结果可通过第三方工具渲染成多种格式。模型支持1024×1024高分辨率输入,具备多页批量处理、动态分块识别和交互式区域选择等创新功能,用户可通过坐标或颜色指定识别区域。基于Apache 2.0协议开源,提供Hugging Face演示和完整代码,适用于学术研究到工业应用的广泛场景,为OCR领域带来突破性解决方案。00- HHowToCook程序员在家做饭方法指南。Programmer's guide about how to cook at home (Chinese only).Dockerfile011
- PpathwayPathway is an open framework for high-throughput and low-latency real-time data processing.Python00
项目优选
收起

deepin linux kernel
C
23
6

OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
229
2.28 K

仓颉编译器源码及 cjdb 调试工具。
C++
112
74

暂无简介
Dart
529
116

仓颉编程语言运行时与标准库。
Cangjie
122
91

仓颉编程语言命令行工具,包括仓颉包管理工具、仓颉格式化工具、仓颉多语言桥接工具及仓颉语言服务。
C++
51
50

React Native鸿蒙化仓库
JavaScript
215
290

Ascend Extension for PyTorch
Python
70
101

🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
990
586

本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
566
102