2010-10-14 27 views
2

傳統上,開發人員(特別是開源項目)習慣於將關於每次更改的說明,日期和名稱寫入名爲ChangeLog,CHANGES或HISTORY的文件中。這種做法是在版本控制系統沒有廣泛使用的時候創建的 - 現在人們可以簡單地輸入git log等來獲取該信息,那麼爲什麼要這麼做呢?你們中的任何人仍在創建一個CHANGES文件或類似的東西?變更日誌和新聞仍然流行嗎?

然後有同樣舊聞文件,我只看到極少數的項目現在。這個文件應該包含發佈版本之間的巨大差異 - 對我來說比CHANGES文件更有意義。你使用這樣的NEWS文件嗎?你怎麼稱呼它?您是否添加了< 1.0版本的條目?您是否添加了第一個版本的所有更改,或者您是否簡單地寫入「初始版本」?

我看像jQuery和Ruby on Rails的靈感一些較新的項目,他們似乎沒有任何在他們的GitHub庫這些文件。

回答

1

我個人還沒有看到一個自願的,每提交更改日誌自90年代中期。

我們不僅現在依靠版本控制的歷史,但單元測試使我們能夠更頻繁地重構。

版本控制不僅提供了歷史,也:版本之間

  • 來源的diff。差異可以幫助識別新缺陷的原因。
  • 可靠的歷史。在自願更改日誌中,可能會忽略或刪除更改。
+0

嗯,關於重構的好點我猜。那不像10年前那樣。我還發現ChangeLog條目通常是完整的東西的實現。當我現在提交 - 經常是實際上 - 我經常寫「像開始工作......」或「繼續工作......」之類的東西。在完全實現指定的功能之前,可能會有4-5次提交。您對NEWS文件有什麼想法? – eomer 2010-10-14 16:11:40

+2

作爲用戶,對於我而言,每個版本的高級更改日誌都很有用。我手寫了幾個類似的摘要;寧願自動生成和過濾。順便提一下,更頻繁地檢查的好點。在整合之前,我發現自己更頻繁地檢查自己的分支。 – 2010-10-14 22:21:34

0

IME,我發現更新日誌,可以在其他的代碼一個真正有用的文件。 VC日誌並不總是以終端用戶爲中心,所以日誌中的API /算法/性能變化有時比明確的,恕我直言更加深奧。

0

我不記得上次我看到ChangeLog文件,但是NEWS文件很常見。其他項目稱之爲CHANGES(可悲的是,沒有標準)。如果沒有它,我會發現看到一個大的FLOSS項目是不幸的。