如果我在每次提交时都更新README.md，那么将大型工作拆分为小型git提交？

Question

我对一个大型开源项目（TensorFlow）上的contrib包进行了设计更改。

我想在小的，定义明确的编译提交中完成我的工作。

当然我会将README.md更新为新设计。我的问题是如何做到这一点：

• 在提交前更新README.md - 代码不会与README.md同步。
• 提交后更新README.md - README.md将不会与代码同步。
• 在每次提交时更新README.md - 单调乏味，但可能是最佳选择。

感谢。

Answer 1

实际上，你的问题没有严格的答案。通常，您应该与存储库的其他代码贡献者讨论此类事情。

根据我自己的经验，我强烈建议您关注atomic commit convention，因为有进行小型高耦合提交的感觉。

根据它：

  

使用修订控制系统时，常见的惯例是使用小型提交。这些有时被称为原子提交，因为它们（理想情况下）仅影响系统的单个方面。这些原子提交允许更好的可理解性，更少的回滚更改工作，更容易识别错误。

这种方法可以保证您的代码在您所做的每次提交时都是一致的，并且还可以更轻松地撤消不需要的东西（使用还原，硬重置等）。

从这个角度来看，你提到的最后一个选项是首选。

想象一下，在一段时间之后你想取消过去的一个提交，这间接迫使你更新用不同提交写的描述。如果您在一次提交中将两个更改相互关联，则可能会更容易。