Back to Details

commit

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Conventional Commits

Conventional Commits

Follow these project-specific rules when creating commits.
创建提交时请遵循以下项目特定规则。

Branching

分支管理

Never create bare branches. If you need branch isolation, use the 
worktree
skill. For simple changes, commit directly on the current branch (including main). Do not run 
git checkout -b
.
切勿创建裸分支。 若需要分支隔离，请使用
worktree
技能。对于简单改动，直接在当前分支（包括main分支）提交即可。请勿执行
git checkout -b
命令。

Project Rules

项目规则

  • One commit per logical change — never combine unrelated fixes or features. Three independent changes = three commits.
  • Only commit files you changed — never pull in unrelated files from concurrent sessions.
  • Always include a body — no title-only commits. Explain what and why.
  • merge
    type     — use 
    merge
    (not a merge commit) when merging a worktree or feature branch.
  • Sequence commits to maximise option value — foundational infrastructure first, then features that build on it.
  • 每次逻辑改动对应一次提交 —— 切勿将不相关的修复或功能合并在一次提交中。三项独立改动 = 三次提交。
  • 仅提交你修改过的文件 —— 切勿引入并发会话中产生的不相关文件。
  • 提交必须包含正文 —— 不允许只有标题的提交。需说明改动内容与原因。
  • merge
    类型     —— 合并worktree或功能分支时，使用
    merge
    类型（而非合并提交）。
  • 合理安排提交顺序以最大化灵活性 —— 先提交基础架构改动，再提交基于其开发的功能。

Example

示例

feat(alerts): Add Slack thread replies for alert updates

When an alert is updated or resolved, post a reply to the original
Slack thread instead of creating a new message. This keeps related
notifications grouped together.
feat(alerts): Add Slack thread replies for alert updates

When an alert is updated or resolved, post a reply to the original
Slack thread instead of creating a new message. This keeps related
notifications grouped together.

References

参考资料