我是 git 的新手,我想知道创建标签和生成/维护变更日志的最佳实践。
直到现在,我总是创建一个 readme.md 并手动指出(在“变更日志”部分中)最重要的功能
例如:
version 1.0.1
- changed layout in home
- added slideshow in gallery
- etc..
我如何创建具有这些特征的更新日志(也许是 markdown 格式)?
- 根据个性化标题/标签标题/日期更改的标题
- 基于标签或提交的更改
我还没有明确的想法,所以建议是正确的
提前致谢:)
最佳答案
目前还没有一些通用的指导方针。但是在 keep a changelog 上解释了很多好的规则。 .
正如他们提到的:
Don’t let your friends dump git logs into changelogs.
我完全同意。
这就是我创建 GitHub Changelog Generator 的原因根据所有这些准则生成变更日志。
实际上它只适用于 GitHub,但它提供了一个很好的例子来说明变更日志应该是什么样子。
它会根据您的标签、问题、标签和 pull 请求自动生成变更日志。
例如:这个变更日志是由这个脚本生成的: 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)
关于Git 和变更日志指南,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/18182081/