开发者的更新日志？

正如您可能已经看到的，我最近发布了一篇帖子，询问如何提高项目的巴士系数。

如何提高您的客流量系数？

Scott Harrison ・ 2018年7月19日

＃讨论

团队开发人员在共同开发项目时，经常会遇到一个相关的问题，那就是当项目发生变更时（无论是代码、设计还是 DevOps 相关变更），如何让每个人都了解情况。

我想到一个可能的解决方案，类似于变更日志，但面向的是开发者而非最终用户。具体来说，每个项目的根目录下都会有一个 changelog.md 文件，每当有新功能合并到主分支时，该文件都会更新。内容应该简洁明了，但要包含未来开发者可能需要了解的所有信息。

例如，最近一位开发人员修改了我们的 Docker 配置，并更新了 readme.md 文件以反映这一更改。然而，当我接手该项目添加新功能时，我没有查看 readme.md 文件，导致我的环境无法正常工作。与其查看提交历史记录或打扰其他开发人员，我本可以简单地查看 changelog.md 文件，并看到以下内容：

31/07/2018
- Now use docker-sync for handling storage in project, details of what you need to change in README.md

这条简单的消息让我了解了重新接手项目并参与之前需要知道的一切。这或许会被视为提交信息的重复，但我发现提交信息通常会提供很多技术细节，说明哪些地方发生了变化。当你重新开始一个项目时，这些细节并不总是那么重要，尤其是在你没有修改过那些提交所涉及的部分的情况下。然而，能够以更宏观的方式快速了解变化内容，用一句话概括出来，仍然非常有用。

一位同事给我看了这个，看起来正合我意：https://keepachangelog.com/en/1.0.0/

你怎么认为？