Skip to content

Latest commit

 

History

History
39 lines (27 loc) · 1.08 KB

README_zh-CN.md

File metadata and controls

39 lines (27 loc) · 1.08 KB

简体中文 | English

Git Hooks 代码规范检查工具

一个基于 Git Hooks 的自动化工具,用于在代码提交前进行规范性检查,确保团队代码质量和提交信息的一致性。

使用方式

  • 将commit-msg文件复制到.git/hooks目录下
  • 将main.exe文件复制到工程目录下,如果你想复制到其他目录下,请留意commit-msg中的路径

主要功能

  • 提交信息(Commit Message)格式检查
  • 代码风格(Code Style)自动检查
  • 代码质量(Code Quality)基础验证
  • 敏感信息泄露检测
  • 分支命名规范检查

技术特点

  • 基于 Git Hooks 机制,特别是 pre-commit 和 commit-msg hooks
  • 零侵入性,易于在团队中推广使用
  • 可配置化,支持自定义检查规则
  • 快速失败机制,提早发现问题

使用场景

  • 规范团队代码提交流程
  • 预防低质量代码提交
  • 确保代码提交信息的规范性
  • 减少代码审查的工作量

优势

  • 自动化执行,无需人工干预
  • 统一团队开发规范
  • 提高代码质量
  • 减少线上问题