Question

我在GitHub上托管了一个开源项目。每次发布我该死的项目后，我想写出一些新功能和错误修复列表，如 History.md 。它看起来像：

=== Version 0.0.1 2012-12-21

Version with a new awesome bugs has been released

* [added] New feature
* [fixed] Some bug fixed

但是我犹豫了。可能是我错了？我不知道，所以我问。是否有任何关于如何格式化历史变化的指导/规则/建议/良好的经验/其他任何内容？或者更改列表不应该是单个文件？

或者更一般地说：对于Github（或任何其他托管）项目，跟踪版本更改（当然是以人类可读的格式）的最佳方式是什么，并以更愉快的方式将其包含在项目本身中？

Answer 1

Github有里程碑问题。

如果您将版本与里程碑相关联，所有更改了故障单，那么：里程碑中的所有已关闭故障单将构成人类可读的更改日志