Git和changelog指南

Question

我是git的 noob ，我想知道创建标签和生成/保存更改日志的最佳做法。

到目前为止，我总是创建一个readme.md并手动指示（在“changelog”部分中）最重要的功能

例如：

  

版本1.0.1

     

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

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

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

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

提前致谢：）

Answer 1

目前还没有一些共同的指导方针。但是在 keep a changelog 上解释了很多好的规则。

他们提到：

  

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

我完全同意。

这就是为什么我创建GitHub Changelog Generator根据所有这些准则生成更改日志的原因。

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

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

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

  

更新日志

     

1.2.5（2015-01-15）

     

Full Changelog

     

已实施增强功能：

     

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

     

修正了错误：

     

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

     

合并拉取请求：

     

  

• PrettyPrint类包含使用小写的“pp”#43（schwing）

  

• 通过命令行选项支持enterprise github #42（glenlovett）

  

Answer 2

我建议您仍然手动描述更改日志中的更改。

很难，您可以通过github diff链接到生成的更改。 例如，更改日志： https://github.com/rspec/rspec-core/blob/master/Changelog.md

差异： https://github.com/rspec/rspec-core/compare/v2.14.2...master

您可能希望浏览一些其他参考开源项目的存储库，其中可以找到许多良好实践。

Answer 3

可能我的答案为时已晚，但现在我正在使用一个神奇的红宝石宝石，它会读取你的git日志并按标签分割，输出是用降价写的，看一看

https://github.com/kebab-project/katip