Git和changelog指南

Question

我是git 的菜鸟,我想知道创建标签和生成/保存更改日志的最佳实践.

到目前为止,我总是创建一个readme.md并手动指示(在"changelog"部分中)最重要的功能

例如:

版本1.0.1

• 改变了家里的布局
• 在库中添加了幻灯片
• 等等..

如何创建具有这些特征的更改日志(可能采用降价格式)？

• 基于个性化标题/标签标题/日期的更改标题
• 基于标签或提交的更改

我还没有一个明确的想法,所以建议很精彩

提前致谢 :)

Answer 1

目前还没有一些共同的指导方针.但是在保留更改日志时会解释很多好的规则.

他们提到:

不要让你的朋友将git日志转储到更改日志中.

我完全同意.

这就是为什么我创建GitHub Changelog Generator,根据所有这些指南生成更改日志.

实际上它只适用于GitHub,但它提供了一个很好的例子,说明更改日志的外观.

它会自动从您的代码,问题,标签和提取请求中生成更改日志.

例如:此更改日志由此脚本生成:CHANGELOG.md

更新日志

1.2.5(2015-01-15)

完整的更新日志

实施增强功能:

• 使用里程碑来指定修复了哪个版本的错误#22

修正了错误:

• 尝试为没有标签#32的 repo生成日志时出错

合并拉取请求:

• PrettyPrint类包含使用小写'pp' #43(schwing)

• 通过命令行选项支持enterprise github #42(glenlovett)