git commit 日志标准

提交日志标准

提交日志是对存储库更改的简短描述。我们应该遵循一定的标准来有效地描述变化,例如:

格式

[{emoji} ]{type}[({module})]: {subject within 50 words}[ (#{issue/pull request})]

例如:

  • 🎉 Feat: add new plugin (#12)
  • ⬆️ Chore(libs): update fxcl from 1.0.0 to 1.0.1 (#10)

表情

说明

表情 类型 例如 说明(无歧义)
🎉:tada: ✨:sparkles: Feat Feat: add {feature} 新功能
🚚:truck: Feat: adjust/migrate {feature name}, {change details} 对于调整特征,需要描述当前情况(之前)和调整之后(之后)
🔥:fire: Feat: delete {feature name}, {deletion reason} 如果特征被删除,必须说明删除原因
🐛:bug: 🚧:construction: 🚨:rotating_light: Fix Fix: fix {bug description} 修复已知错误
🎨:art: 💄:lipstick: ✏️:pencil2: Style Style: Typesetting/CSS style {optimizing content} 不影响代码运行的变化,如代码布局、样式变化
♻️:recycle: Refactor Refactor: override {feature name} 它既不是新功能,也不是为了修复错误而更改代码。简单地重写函数的代码不会影响函数结果
⚡:zap: Perf Perf: improve performance {function name}, {improve content} 优化代码性能
⏪:rewind: Revert Revert: restore version {commit message of restore version} 恢复一次提交的版本
✏:pencil: ✏️:pencil2: Docs Docs: revise comments/update documents 文件和注释的调整
🔧:wrench: Chore Chore: update plugin version 施工工艺或辅助工具的变化