变更日志和新闻仍然流行吗?

时间:2010-10-14 14:19:12

标签: project-management

传统上,开发人员(尤其是开源项目)过去常常将描述,日期和名称的每个变更都写入一个名为ChangeLog,CHANGES或HISTORY的文件。这种做法是在没有广泛使用的版本控制系统的时候创建的 - 现在人们可以简单地输入git log等来获取这些信息,为什么还要费心呢?你们中的任何人还在创建一个CHANGES文件或类似的东西吗?

然后是同样旧的NEWS文件,我现在只在很少的项目中看到。这个文件应该包含版本之间的巨大差异 - 对我来说比CHANGES文件更有意义。你使用这样的新闻档案吗?你怎么称呼它?您是否为< 1.0版本添加条目?您是否添加了第一个版本的所有更改,或者只是编写“初始版本”?

我看了一些像jQuery和Ruby on Rails这样的新项目的灵感,他们似乎没有在他们的GitHub存储库中有任何这些文件。

3 个答案:

答案 0 :(得分:1)

自从90年代中期以来,我个人没有看到自愿的,每次提交的更改日志。

我们现在不仅依赖于历史版本控制,而且单元测试允许我们更频繁地重构。

版本控制不仅提供历史记录,还提供:

  • 版本之间的源差异。差异可以帮助确定新缺陷的原因。
  • 可靠的历史。在自愿更改日志中,可能会忽略或删除更改。

答案 1 :(得分:0)

IME,我发现更改日志在其他代码中是一个非常有用的文档。 VC日志并不总是在考虑最终用户的情况下编写,因此日志中的API /算法/性能变化有时比显式更加深奥,恕我直言。

答案 2 :(得分:0)

我不记得上次看到ChangeLog文件了,但是NEWS文件很常见。其他项目称之为CHANGES(遗憾的是没有标准)。如果没有它,我会发现看到一个庞大的FLOSS项目是不幸的。