執行變更記錄

已完成

變更記錄的概念很簡單：其為一個檔案，其中包含對專案所做的變更清單，通常是以日期順序排列。 一般明細用於分隔版本清單，並在每個版本中顯示：

• 已新增的功能
• 已修改/已改善的功能
• 已刪除的功能

有些小組會將變更記錄張貼為部落格文章；其他小組則會在 GitHub 存放庫中建立 CHANGELOG.md 檔案。

自動化變更記錄工具

雖然可以建立變更記錄並手動加以維護，但您可能會想考慮使用自動化的變更記錄建立工具。 至少作為一個起點。

使用原生 GitHub 命令

Git 記錄命令對於自動建立內容很實用。 範例：為每個版本建立新的區段：

git log [options] vX.X.X..vX.X.Y | helper-script > projectchangelogs/X.X.Y

Git 變更記錄

其中一個標準工具是 gitchangelog。 此工具是以 Python 為基礎。

GitHub 變更記錄產生器

另一個標準工具稱為 github-changelog-generator。

$ github_changelog_generator -u github-changelog-generator -p TimerTrend-3.0

此工具是以 Gem 為基礎。

您應該使用自動產生且以記錄為基礎的資料嗎？

喜好設定一律會避免將記錄項目傾印到變更記錄中。 記錄是「雜訊」，因此很容易產生沒有幫助的混亂。