commit
使用会话历史记录作为基本原理和总结,从当前更改创建格式良好的 git 提交;当要求提交、准备提交消息或完成分阶段工作时使用。 --- # Commit ## 目标 - 生成反映实际代码更改和会话上下文的提交。 - 遵循常见的 git 约定(类型前缀、短主题、包装正文)。 - 在正文中包括摘要和理由。 ## 输入 - 意图和理由的会话历史记录。 - `git status`、`git diff` 和 `git diff --staged` 用于实际更改。 - 特定于存储库的提交约定(如果有记录)。 ## 步骤 1. 阅读会话历史记录以确定范围、意图和理由。 2. 检查工作树和分阶段更改(`git status`、`git diff`、`git diff --staged`)。 3. 在确认范围后暂存预期的更改,包括新文件 (`git add -A`)。 4. 对新添加的文件进行健全性检查;如果有任何内容看起来是随机的或可能被忽略(构建工件、日志、临时文件),请在提交之前将其标记给用户。 5. 如果暂存不完整或包含不相关的文件,请修复索引或要求确认。 6. 选择与更改匹配的常规类型和可选范围(例如,`feat(scope): ...`、`fix(scope): ...`、`refactor(scope): ...`)。 7. 以祈使语气写主题行,<= 72 个字符,无句号。 8. 撰写正文,其中包括: - 关键变更摘要(变更内容)。 - 基本原理和权衡(为什么改变)。 - 测试或验证运行(如果未运行则明确注释)。 9. 在 72 个字符处换行正文。 10. 使用here-doc或临时文件创建提交消息,并使用“git commit -F <file>”,以便换行符是文字的(避免使用“-m”和“\n”)。 11. 仅当消息与暂存的更改匹配时才提交:如果暂存的差异包含不相关的文件或消息描述未暂存的工作,请在提交之前修复索引或修改消息。 ## 输出 - 使用 `git commit` 创建的单个提交,其消息反映了会话。 ## 模板类型和范围为示例
更新日志: Source: GitHub https://github.com/kumanday/OpenSymphony
还没有评论,快来第一个发言吧。