我是一个Git的新手，想了解创建标签、生成和维护更改日志的最佳实践。
到目前为止，我总是创建一个readme.md文件，并在“修改日志”部分手动指定最重要的功能。
例如：
版本1.0.1
- 在主页中更改了布局
- 在画廊中添加了幻灯片
- 等等..
如何创建一个满足以下特点的更改日志（可能是以Markdown格式）？
- 基于个性化标题/标记标题/日期的更改标题
- 基于标签或提交的更改
我还没有明确的想法，所以欢迎提出建议。
谢谢您提前：）
3个回答
18
目前还没有一些常见的准则，但是在 keep a changelog 上解释了很多好的规则。
正如他们所提到的:
这就是我创建 GitHub Changelog Generator 的原因，它可以根据所有这些指南生成一个changelog。
实际上，它只适用于 GitHub，但它展示了一个changelog应该是什么样子。
它会从您的标签、问题、标签和拉取请求自动生成一个changelog。
例如: 这个changelog是由这个脚本生成的: CHANGELOG.md
正如他们所提到的:
我完全同意这个观点。不要让你的朋友把git日志倒入changelogs中。
这就是我创建 GitHub Changelog Generator 的原因，它可以根据所有这些指南生成一个changelog。
实际上，它只适用于 GitHub，但它展示了一个changelog应该是什么样子。
它会从您的标签、问题、标签和拉取请求自动生成一个changelog。
例如: 这个changelog是由这个脚本生成的: CHANGELOG.md
Changelog
1.2.5 (2015-01-15)
Implemented enhancements:
- Use milestone to specify in which version bug was fixed #22
Fixed bugs:
- Error when trying to generate log for repo without tags #32
Merged pull requests:
PrettyPrint class is included using lowercase 'pp' #43 (schwing)
support enterprise github via command line options #42 (glenlovett)
- skywinder
1
这是否意味着每次提交代码后，我们都需要再提交一次以保存 CHANGELOG.md 文件的更改记录？ - Janshair Khan
3
我建议您仍然在变更日志中手动描述更改。
不过，您可以通过 GitHub diff 链接到生成的更改。例如，变更日志： https://github.com/rspec/rspec-core/blob/master/Changelog.md 以及差异： https://github.com/rspec/rspec-core/compare/v2.14.2...master 您可能想要查看其他一些参考开源项目的存储库，那里有很多好的实践经验可以找到。
不过，您可以通过 GitHub diff 链接到生成的更改。例如，变更日志： https://github.com/rspec/rspec-core/blob/master/Changelog.md 以及差异： https://github.com/rspec/rspec-core/compare/v2.14.2...master 您可能想要查看其他一些参考开源项目的存储库，那里有很多好的实践经验可以找到。
- jurglic
3
也许我的回答有点晚了，但是现在我正在使用一个神奇的Ruby宝石(katip)，它可以读取你的git日志并按标签拆分，输出以Markdown格式编写的内容，快来看看吧。
- rderoldan1
网页内容由stack overflow 提供, 点击上面的可以查看英文原文，
原文链接
原文链接