修复错误代码的 git commit 消息是什么？ [关闭]

Question

我提交并推送了我的代码，然后意识到代码写得不好。我应该写什么作为修复/清理该代码的提交消息？

只是“修复错误代码”？

Answer 1

想想五年后有人看着你的变化。他们可以看到您做了什么，但他们不知道为什么。你的提交信息解释了为什么，以及你对这个人（可能是你）所做的事情的背景。

您的提交应该足够小，以便您可以提供您所做工作的摘要。

使用Semantic Commit Messages 提供一般结构。

fix 用于修复错误。

fix: Forgot to strip whitespace before handling user input

refactor 将用于重新设计代码。

refactor: Redesign the Frobniz system

Frobniz was too complicated, so I extracted it into
Frobniz::Parse and Frobniz::Push. Frobniz delegates to
these objects now.

也许您忘记添加文档了。

docs: adding documentation to Frobniz

Answer 2

您可以随意使用您的提交消息，只要它描述了提交正在做什么。