几天前,我更新了 Chakra UI 的更新日志,并学到了一些关于记录更新日志的知识。

我决定在下面分享它们:

不确定什么是变更日志?

changelog是项目每个版本的所有显着更改的精选记录。这些更改可能是错误修复、更新、新功能等。

为什么拥有变更日志很重要?

• 它使贡献者和用户可以轻松一目了然地查看项目每个版本之间所做的更新。

• 在项目出现中断的情况下,更改日志可帮助您轻松追踪中断发生的点。

• Changelog 还可以作为让用户对项目的错误修复和新功能感到兴奋的一种方式。

如何写一个好的更新日志

• 将最新更改放在首位:虽然保留所有更改的记录是件好事,但重要的是首先放置最新更改和更新。也就是说,在记录变更日志时使用倒序。为什么?大多数人都对最新的变化真正感兴趣,所以首先展示它。

[](https://res.cloudinary.com/practicaldev/image/fetch/s--zZP9SI7j--/c_limit%2Cf_auto%2Cfl_progressive%2Cq_auto%2Cw_880/https://dev- to-uploads.s3.amazonaws.com/uploads/articles/xirzkrsjfyylhj49myi2.png)

• 基于发布日期的组更改:每个发布日期所做的所有更改和更新都应组合在一起。

[](https://res.cloudinary.com/practicaldev/image/fetch/s--RM_KAIIP--/c_limit%2Cf_auto%2Cfl_progressive%2Cq_auto%2Cw_880/https://dev- to-uploads.s3.amazonaws.com/uploads/articles/t259w2ec5wlvfxfk5vfc.png)

• 保持简单和简短:由于变更日志的目标是让用户更容易跟踪更改,所以用简单的英语编写并避免不必要的技术术语是有意义的。

--

• 格式正确:变更日志应该易于阅读和浏览。在编写变更日志时使用标题和项目符号。

[](https://res.cloudinary.com/practicaldev/image/fetch/s--wTZxXFe7--/c_limit%2Cf_auto%2Cfl_progressive%2Cq_auto%2Cw_880/https://dev- to-uploads.s3.amazonaws.com/uploads/articles/18vzv7w8wrkpdt1lqbv4.png)

• 对所做的更改进行分类,并将其作为前缀添加到更改摘要之前。例如,是错误修复还是添加了新功能?legends的使用在这里非常有用。

[](https://res.cloudinary.com/practicaldev/image/fetch/s--WmVrLirj--/c_limit%2Cf_auto%2Cfl_progressive%2Cq_auto%2Cw_880/https://dev- to-uploads.s3.amazonaws.com/uploads/articles/nwdubrfad0h26ibk3sos.png)

单击此处查看来自 Chakra UI 的更改日志