git - 我可以提交/推送一个文件，在 git 中省略某些注释吗？

Question

假设我和一个 friend 正在处理一个文件 work.txt，它位于 github 存储库中。我想对此文件发表一些评论，这些评论存在于我的本地副本中，但在我更新时不会被推送。这可能与 git 相关吗？

举个例子，这个文件是一些代码，我想添加一些关于函数的信息作为注释，这样我自己就记住了，但是我的 friend 清楚地记得函数的作用，他不需要注释那里。我希望此评论出现在我的本地文件中，但不出现在存储库中。此外，我希望当文件更新时，评论保留在我本地机器的更新版本中(否则我可以简单地保留一个本地副本并在更新时覆盖评论)。

Answer 1

你可以使用 Git smudge and clean filters这允许您使用自定义脚本在提交/ checkout 时替换文件。其中，smudge 表示每当您 checkout 任何内容时执行此代码 并且clean 表示每当您 checkin 任何内容时都运行此代码。

clean 过滤器脚本将必须删除您所有的评论，您可能必须在它前面加上一个特殊的模式。并将这些评论保存到辅助差异文件中。

smudge 过滤器必须将辅助差异文件应用到原始文件以恢复您的评论。

使用它，您在提交之前不需要做任何特别的事情。即:只需提交，clean 过滤器将处理您的工作副本评论。

有一些带有示例的 repo 协议(protocol):

• https://github.com/CodeRevver/smudge-clean
• https://github.com/gilesbowkett/git-smudge-and-clean

无论如何，这感觉有点矫枉过正，额外的评论不会对存储库造成伤害，如果编写得当，它们将作为文档使用。