写 TODO 来提交消息是个好习惯吗?
Is it a good habit to write TODO to commit message?
我刚刚意识到我更喜欢将 TODO 注释直接写入最新的提交而不是问题跟踪器,例如:
TODO:
- Remove console.log
- Check that XY works
- ...
例如,如果我必须切换到另一份工作,完成它并回到这个分支,我可以看到我未完成的事情,修复它,commit --amend
,从提交消息中删除 TODO 语句.
这是一个好习惯还是我应该强迫自己使用问题跟踪器并在那里写下每一个小笔记(即使其他人可以看到该问题)?
返回并调用 commit --amend
更像是临时修复,而不是常规工作流程。
如果您已经 push
编辑了您的分支,那么您将使其他人看到的提交无效。
在问题跟踪器是一种矫枉过正的情况下 - 我完全可以理解 - 只需以任何形式保留单独的 TODO 文件,例如降价的纯文本,然后将其更改添加到您的代码提交中。
我认为这是次优的。
考虑一下:如果 TODO 引用 code,它应该紧挨着那段代码。如果您将它写在提交消息中,它就会完全分离。当您的同事想要实施 TODO 时,她如何确定要查看的位置?
如果 TODO 指的不是代码,而是基础设施、文档等,那么最好维护一个 TODO
文件 因为它更容易至
- 查找活动的 TODO 列表
- 将项目移至完成(例如,只需将其删除)
假设您想要一个 TODO 项目列表。在您的方法中,您可以 grep 所有提交消息吗?你怎么知道哪些 TODO 已经完成?一个单独的文件使这个答案变得非常简单。
我刚刚意识到我更喜欢将 TODO 注释直接写入最新的提交而不是问题跟踪器,例如:
TODO:
- Remove console.log
- Check that XY works
- ...
例如,如果我必须切换到另一份工作,完成它并回到这个分支,我可以看到我未完成的事情,修复它,commit --amend
,从提交消息中删除 TODO 语句.
这是一个好习惯还是我应该强迫自己使用问题跟踪器并在那里写下每一个小笔记(即使其他人可以看到该问题)?
返回并调用 commit --amend
更像是临时修复,而不是常规工作流程。
如果您已经 push
编辑了您的分支,那么您将使其他人看到的提交无效。
在问题跟踪器是一种矫枉过正的情况下 - 我完全可以理解 - 只需以任何形式保留单独的 TODO 文件,例如降价的纯文本,然后将其更改添加到您的代码提交中。
我认为这是次优的。
考虑一下:如果 TODO 引用 code,它应该紧挨着那段代码。如果您将它写在提交消息中,它就会完全分离。当您的同事想要实施 TODO 时,她如何确定要查看的位置?
如果 TODO 指的不是代码,而是基础设施、文档等,那么最好维护一个 TODO
文件 因为它更容易至
- 查找活动的 TODO 列表
- 将项目移至完成(例如,只需将其删除)
假设您想要一个 TODO 项目列表。在您的方法中,您可以 grep 所有提交消息吗?你怎么知道哪些 TODO 已经完成?一个单独的文件使这个答案变得非常简单。