变更日志和发行说明

主要观点:应区分详细的变更日志和简短的发布说明,若项目仅依赖 GitHub 作为沟通平台则难以做到,变更日志应全面包含各种变更,发布说明则是对用户可感知变更的散文式总结,二者相辅相成,且 GitHub 设计更倾向于变更日志,对发布说明的展示和推广不足。
关键信息

  • Ned 提出“提交列表不是变更日志”,引发此讨论。
  • Karl Fogel 认为应有“CHANGES”文件解释新版本的新内容,应给用户升级的概述和不兼容变更的告知。
  • 变更列表过长时应分类,如 MediaWiki 的变更日志。
  • 对于变更日志的详细程度存在分歧,Dreamwidth 有代码游览和总结性发布说明。
  • 发布说明可用于宣布一些不适合变更日志但用户应知道的事情,如系列的最后一个版本等。
  • 一些维护者对写发布说明有顾虑,且通信媒介的变化使项目更多依赖 GitHub,其对发布说明的展示和推广不佳。
    重要细节
  • 不同项目对变更日志的处理方式不同,如 pip 保持一个巨大的变更日志,MediaWiki 将以前版本的变更日志移到单独文件。
  • 示例中 Dreamwidth 的代码游览和发布说明,Leonard Richardson 的 Beautiful Soup 4.13.0 发布说明等。
  • 提及 GitHub 发布流程及相关限制,如创建发布、关联 Git 标签等。
  • 介绍 Divio 的“四种文档”框架中变更日志和发布说明的区别。
  • 作者可提供相关咨询和培训服务,以及正在写关于管理现有开源项目的书。
阅读 13
0 条评论