Skip to main content

Git Message

Semantic Commit​

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
  • type
    • fix: 修复 bug - 为用户修复的错误，而不是构建脚本的修复。此类提交将触发补丁版本的发布。
    • feat: 新功能 - 为用户提供的新功能，而不是构建脚本的新功能。此类提交将触发次要版本的发布。
    • chore: 构建过程、辅助工具、文档生成、升级
    • refactor: 重构
    • style: 重构生产代码，例如重命名变量。
    • docs: 文档
    • ci: 持续集成
    • perf: 性能优化 - 性能改进。此类提交将触发补丁版本的发布。
    • test: 测试 - 添加缺失的测试、重构测试；没有生产代码的更改。
    • revert: 撤销
    • localize: 本地化
    • build: 更新构建配置、开发工具或其他与用户无关的更改。
    • style: 格式更改、缺少分号等。
  • feat(xyz)!
    • ! for BREAKING CHANGE
  • footer 
const r = /^(feat|fix|docs|style|perf|merge|build|localize|revert|refactor|test|chore|ci)([(].+？[)])?!?: .{1,120}/;

Message​

  • Angular 社区提交规范
    • ^(feat|fix|docs|style|refactor|test|chore|ci)((.+))?: .{1,100}
  • jQuery 社区提交规范
    • ^(Fixes|Closes|Ref)? .{1,100}
  • Atom 社区提交规范
    • ^(:.*:)? .{1,72}
  • JSHint 社区提交规范
    • ^([[(FIX|FEAT|DOCS|TEST|CHORE)]])? .{1,100}
  • ESLint 社区提交规范
    • ^(Fix|Update|New|Breaking|Docs|Build|Upgrade|Chore)?: .{1,72}

特殊​

Github

[skip ci]
[ci skip]
[no ci]
[skip actions]
[actions skip]

footer

skip-checks:true
skip-checks: true

Issue Labels​

  • Issue 管理 vs 任务管理
    • Issue - 问题驱动 - 解决问题、改进产品
      • 发现问题 - 分类 - 优先级 - 指派 - 处理 - 验证 - 关闭
    • 任务 - 完成特定目标或交付物为导向 - 完成具体工作目标
      • 目标分解 - 任务分派- 进度跟踪 - 任务完成
  • feat 类 Issue 可看作是任务
  • wip → ready for review → ready for release → closed/released
标签描述
bug错误报告
duplicate重复问题
enhancement功能增强
help wanted需要帮助
invalid无效问题
question问题
wontfix不予解决
Extra---
wip进行中
ready for review待审查
ready for merge待合并
ready for test待测试
ready for release待发布
P1, P2, P3, P4, P5优先级
Advanced
Kind/Bug错误
Kind/Feature新功能
Kind/Enhancement增强
Kind/Security安全问题
Kind/Testing测试
Kind/Documentation文档
Compat/Breaking重大变更
Reviewed/Duplicate已审查重复
Reviewed/Invalid已审查无效
Reviewed/Confirmed已确认
Reviewed/Won't Fix已审查不予解决
Status/Need More Info需要更多信息
Status/Blocked阻塞
Status/Abandoned已放弃
Priority/Critical关键优先级
Priority/High高优先级
Priority/Medium中优先级
Priority/Low低优先级

参考​