我刚刚意识到我更喜欢将 TODO 注释直接写入最新提交而不是问题跟踪器，例如：
TODO:
- Remove console.log
- Check that XY works
- ...
例如，如果我必须切换到另一个工作，完成它并返回到这个分支，我可以看到我还没有完成什么，修复它，commit --amend从提交消息中删除 TODO 语句。
这是一个好习惯还是我应该强迫自己使用问题跟踪器并在那里写下每一个小笔记（即使其他人可以看到问题）？
问问题
5471 次
2 回答
4
我会说这是次优的。
考虑一下：如果 TODO 引用代码，则它应该位于该代码的旁边。如果你把它写在一个提交消息中，它就会完全分离。当你的程序员同事想要实现 TODO 时，她是如何确定在哪里寻找的？
如果 TODO 不是指代码，而是指基础设施、文档等，那么维护TODO 文件会好得多，因为这样更容易维护
- 找到活跃的 TODO 列表
- 将一个项目移动到 DONE（例如简单地删除它）
想象一下，您想要一个 TODO 项目列表。在您的方法中，您可以 grep 所有提交消息吗？你怎么知道哪些 TODO 已经完成？一个单独的文件使这个答案变得超级简单。
于 2018-07-10T08:19:09.147 回答
0
返回并调用commit --amend是为了临时修复，而不是常规工作流程。
如果您push已经编辑了您的分支，那么您将使其他人看到的提交无效。
在问题跟踪器过度杀伤的情况下 - 我完全可以理解 - 只需以任何形式保留单独的 TODO 文件，例如降价的纯文本，然后将其更改添加到您的代码提交中。
于 2018-07-10T08:13:53.120 回答