编写TODO提交消息是否是一个好习惯？

Question

我刚刚意识到，我更喜欢直接将TODO注释写到最新提交中，而不是问题跟踪器中，例如：

TODO:
- Remove console.log
- Check that XY works
- ...

例如，如果我必须切换到另一项工作，请完成它并返回该分支，我可以看到我遗漏的内容，对其进行了修复，commit --amend，从提交消息中删除了TODO语句。 / p>

这是一个好习惯吗？还是我应该强迫自己使用问题跟踪程序并在其中写下所有小注释（即使其他人可以看到问题）？

Answer 1

我会说它不是最优的。

考虑一下：如果TODO引用代码，则该代码应该在该代码段的旁边。如果将其写入提交消息中，它将完全分离。您的程序员同伴如何在想实现TODO时确定要看的地方？

如果TODO所指的不是代码，而是基础架构，文档等，那么维护TODO 文件会更好，因为它更容易

• 找到有效的待办事项列表
• 将项目移至“完成”（例如，将其删除）

想象一下，您想要一个待办事项列表。在您的方法中，可以grep所有提交消息吗？您怎么知道完成哪些待办事项？单独的文件使此答案超级容易。

Answer 2

返回并调用commit --amend只是为了临时修复，而不是常规工作流程。

如果您已经push创建了分支，那么您将使其他人看到的提交无效。

在问题跟踪器过大的情况下-我完全理解-只需以任何形式保存单独的TODO文件，例如markdown的纯文本，然后将其更改添加到代码提交中。