实现更改日志

已完成

更改日志的概念非常简单：它是一个文件，其中包含对项目所做的更改列表（通常按日期顺序）。 典型的细分是分离版本列表，然后在每个版本内显示：

• 添加了功能
• 已修改/改进的功能
• 已删除的功能

某些团队将发布变更日志作为博客文章;其他人将在 GitHub 存储库中创建 CHANGELOG.md 文件。

自动更改日志工具

虽然可以创建和手动维护更改日志，但可能需要考虑使用自动更改日志创建工具。 至少作为起点。

使用原生 GitHub 命令

git log 命令可用于自动创建内容。 示例：为每个版本创建新节：

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。

是否应使用自动生成的基于日志的数据？

偏好是避免直接将日志条目写入更改日志。 日志是“嘈杂”的，因此很容易生成毫无帮助的混乱。