git commit规范

# [页眉] <type>(<scope>): :emoji: <subject>
# - type: feat, fix, perf, refactor, style, build, revert, docs, test,
#         chore, milestone, release, developing, patch
# - scope: 可为空
# - subject: 以动词开始的短语,结尾无句号
# - 页眉只占一行
# - 每行总长度不超过72个字符(中文字符算2个字符)
#
# [正文] 描述
# - 为什么需要修改?
# - 如何定位问题?
# - 修改有什么副作用?
# - 每行总长度不超过72个字符(中文字符算2个字符)
#
# [页脚]
# - 问题的ID或链接
# - BREAKING CHANGE(破坏API原型的修改)
# - 每行总长度不超过72个字符(中文字符算2个字符)

参考:https://www.conventionalcommits.org/

type说明

  • feat: 新功能
    • emoji:
      • 新增 :sparkles:
      • 移除 :fire:
      • 升级依赖 :arrow_up:
      • 编译系统 :green_heart:
  • fix: 修复BUG
    • emoji:
      • :bug:
  • perf: 性能优化
    • emoji:
      • :zap:
  • refactor: 重构代码
    • emoji:
      • 重构 :hammer:
      • 移除 :fire:
  • style: 格式调整(删除行尾空格等)
    • emoji:
      • :art:
  • build: 编译系统
    • emoji:
      • :green_heart:
  • revert: 回退提交
    • emoji:
      • 回退代码 :rewind:
      • 降级依赖 :arrow_down:
  • docs: 文档
    • emoji:
      • :book: :memo:
  • test: 测试
    • emoji:
      • :white_check_mark:
  • chore: 其他未归类的零碎事务
    • emoji:
      • 配置相关 :wrench:
      • 文档相关 :book: :memo:
  • milestone: 更新大版本号
    • emoji: :bookmark:
  • release: 更新稳定版的小版本号(偶数)
    • emoji:
      • :bookmark:
  • developing: 切换到下一个开发版的小版本号(奇数)
    • emoji:
      • :construction:
  • patch: 更新修订号
    • emoji:
      • :bookmark:

字符集

全部使用utf-8字符集。

Windows下设置git指南

  1. git-windows的安装目录\etc\profile中增加环境变量
export LESSHARESET=utf-8
  1. 设置字符集

下面的命令是为单个项目设置utf-8字符集,也可以在 git config后面加上--global使其全局生效。

git config i18n.commitencoding utf-8    # 设置提交日志使用utf-8
git config i18n.logoutputencoding utf-8 # 设置输出日志时使用utf-8
git config core.quotepath false         # 中文路径使用utf-8
git config gui.encoding utf-8           # 图形界面使用utf-8