厘清 GitHub 上软件发布说明问题的迷思
软件工程
2022-03-30 v1
摘要
发布说明(RNs)总结了两个连续软件版本之间的主要变更,并在用户升级软件时作为核心信息来源。尽管生成高质量的 RNs 可能很困难,并给开发者带来各种挑战,但目前仍缺乏对这类挑战的全面实证理解。在本文中,我们通过对 1,731 个最新 GitHub issues 进行人工分析,构建了涵盖内容、呈现、可访问性和生成四个维度的 RN 问题综合分类体系,从而弥合了这一知识缺口。在这些问题中,近一半(48.47%)聚焦于生成;内容、可访问性和呈现分别占 25.61%、17.65% 和 8.27%。我们发现:1)RN 生成者更可能遗漏信息而非包含错误信息,尤其是破坏性变更;2)不当的排版可能埋没重要信息并混淆用户;3)许多用户因链接失效、缺乏通知以及 RN 位置模糊而认为 RNs 难以获取;4)尽管 RN 生成者有巨大需求,自动化与规范化 RN 生成仍然具有挑战性。我们的分类体系不仅描绘了在实践中改进 RN 生成的路线图,还揭示了自动化 RN 生成方面有趣的未来研究方向。
引用
@article{arxiv.2203.15592,
title = {Demystifying Software Release Note Issues on GitHub},
author = {Jianyu Wu and Hao He and Wenxin Xiao and Kai Gao and Minghui Zhou},
journal= {arXiv preprint arXiv:2203.15592},
year = {2022}
}
备注
Accepted for IEEE/ACM 30th International Conference on Program Comprehension (ICPC 2022)