3. 什么是 Changelog 以及如何编写？

最新推荐文章于 2024-08-20 09:48:13 发布

Q shen

最新推荐文章于 2024-08-20 09:48:13 发布

阅读量1.8k

点赞数

分类专栏：开发运营技巧（27 个系列）文章标签： git github

本文链接：https://blog.csdn.net/qq_52010446/article/details/130598630

版权

本文介绍了Changelog的重要性和作用，指出虽然版本控制系统如Git的日志可以提供变更信息，但在团队协作中，维护一个清晰的Changelog文件更为重要。Changelog通常包含项目的所有显著变更记录，按版本顺序排列。文章提到了两种标准格式：GNU的传统方式和更现代的Keep a Changelog。后者使用Markdown，结构更清晰，便于阅读和链接到具体变更。通过Changelog，可以方便地跟踪项目的演进和关联的 tickets。

摘要由CSDN通过智能技术生成

在应用程序或 API 上工作，我们希望了解其他人所做的更改（新功能、更新、修复…），或者让他们知道您所做的事情。

为什么不使用 Git 来做呢？
如果您使用的是 VCS （版本控制系统 - Git、Subversion…），您可以认为它的日志足以知道发生了什么。但是，如果您和您的同事投入很多，并且可能同时在同一个项目中工作，那么您可能会失去正确的轨道。

它可以工作，但需要更多的时间和精力才能做好。（并且重构提交以拥有漂亮的轨道会更容易）

使用更新日志
什么是更新日志？
我们可以在维基百科上找到

变更日志是对项目所做的所有显着变更的日志或记录。

通常，所有变更日志都包含在一个文件中，其中从最新版本到最早版本列出了版本描述。

Changelog 文件是如何构建的？
从技术上讲，您可以随心所欲。如果你想为你的项目或你的企业建立一个特定的标准，你可以！

但是，如果您不是在寻找自定义格式，或者如果您想拥有基础，那么互联网上已经存在一些标准。

GNU - 变更日志
它可以被定义为“老派方式”。

写在一个文本文件中，看起来像这样

2019-08-29  Noam Postavsky  <npostavs@gmail.com>

    Handle completely undecoded input in term (Bug#29918)

    * lisp/term.el (term-emulate-terminal): Avoid errors if the whole
    decoded string is eight-bit characters.  Don't attempt to save the
    string for next iteration in that case.
    * test/lisp/term-tests.el (term-decode-partial)
    (term-undecodable-input): New tests.

2019-06-15  Paul Eggert  <eggert@cs.ucla.edu>

    Port to platforms where tputs is in libtinfow

    * configure.