论文标题

在github上揭开软件发行注释问题

Demystifying Software Release Note Issues on GitHub

论文作者

Wu, Jianyu, He, Hao, Xiao, Wenxin, Gao, Kai, Zhou, Minghui

论文摘要

发行说明(RNS)总结了两个连续软件版本之间的主要更改,并在用户升级软件时作为信息来源。尽管生产高质量的RN可能很难,并且对开发人员构成了各种挑战,但仍然缺乏对这些挑战的全面经验理解。在本文中,我们通过手动分析1,731个最新的GitHub问题来弥合这一知识差距,以构建具有四个维度的RN问题的全面分类学:内容,演示,可访问性和生产。在这些问题中,近一半(48.47%)专注于生产;内容,可访问性和演示分别为25.61%,17.65%和8.27%。我们发现:1)RN生产商更有可能错过信息,而不是包含错误的信息,尤其是用于破坏变化; 2)布局不当可能掩埋重要信息并使用户感到困惑; 3)许多用户发现,由于链接恶化,缺乏通知和混淆RN位置,RN无法访问; 4)尽管RN生产商非常需要,但自动化和调节RN产量仍然具有挑战性。我们的分类法不仅描绘了在实践中改善RN生产的路线图,而且还揭示了有趣的RN生产自动化研究方向。

Release notes (RNs) summarize main changes between two consecutive software versions and serve as a central source of information when users upgrade software. While producing high quality RNs can be hard and poses a variety of challenges to developers, a comprehensive empirical understanding of these challenges is still lacking. In this paper, we bridge this knowledge gap by manually analyzing 1,731 latest GitHub issues to build a comprehensive taxonomy of RN issues with four dimensions: Content, Presentation, Accessibility, and Production. Among these issues, nearly half (48.47%) of them focus on Production; Content, Accessibility, and Presentation take 25.61%, 17.65%, and 8.27%, respectively. We find that: 1) RN producers are more likely to miss information than to include incorrect information, especially for breaking changes; 2) improper layout may bury important information and confuse users; 3) many users find RNs inaccessible due to link deterioration, lack of notification, and obfuscate RN locations; 4) automating and regulating RN production remains challenging despite the great needs of RN producers. Our taxonomy not only pictures a roadmap to improve RN production in practice but also reveals interesting future research directions for automating RN production.

扫码加入交流群

加入微信交流群

微信交流群二维码

扫码加入学术交流群,获取更多资源