To Follow or Not to Follow: Understanding Issue/Pull-Request Templates on GitHub

被引:5
作者
Li, Zhixing [1 ]
Yu, Yue [1 ]
Wang, Tao [1 ]
Lei, Yan [2 ]
Wang, Ying [3 ]
Wang, Huaimin [1 ]
机构
[1] Natl Univ Def Technol, Coll Comp, Changsha 410073, Hunan, Peoples R China
[2] Chongqing Univ, Sch Big Data & Software Engn, Chongqing 400044, Peoples R China
[3] Northeasthern Univ, Software Coll, Shenyang 110004, Liaoning, Peoples R China
关键词
Codes; Software development management; Computer bugs; Guidelines; Documentation; Collaboration; Behavioral sciences; GitHub; issue template; open source software; pull-request template;
D O I
10.1109/TSE.2022.3224053
中图分类号
TP31 [计算机软件];
学科分类号
081202 ; 0835 ;
摘要
For most Open Source Software (OSS) projects, issues and Pull-requests (PR) are the primary means by which stakeholders of a project report and discuss software problems and code changes, and their descriptions are important for people to understand them. To help ensure the informational quality of issue/PR descriptions, GitHub introduced the issue/PR template feature, which pre-populates the description for anyone trying to open a new issue/PR. To better understand this feature, we report on a large-scale, mixed-methods empirical study of templates that explores contents, impacts, and perceptions. Our results show that templates typically contain elements to greet contributors, explain project guidelines, and collect relevant information. After template adoption, the monthly volume of incoming issues and PRs decreases, and issues have fewer monthly discussion comments and longer resolution duration. Although both contributors and maintainers positively rated the usefulness of templates from various aspects, they also reported challenges in using templates (e.g., excessive and irrelevant information request) and suggested potential improvements of the template feature (e.g., better user interaction and advanced automation). This work contributes to the informed use and targeted improvement of templates to enhance OSS practitioners' collaboration and interaction.
引用
收藏
页码:2530 / 2544
页数:15
相关论文
共 74 条
  • [1] Nguyen AT, 2012, IEEE INT CONF AUTOM, P70, DOI 10.1145/2351676.2351687
  • [2] [Anonymous], 2019, GITHUB DRAFT PULL RE
  • [3] [Anonymous], 2022, Github REST API
  • [4] [Anonymous], 2016, GITHUB ISSUE PULL RE
  • [5] [Anonymous], 2022, Replication package
  • [6] [Anonymous], 2022, ABOUT US
  • [7] [Anonymous], 2019, COMMUNICATION
  • [8] [Anonymous], 2022, CREAT ISS FORMS GITH
  • [9] Bacchelli A, 2013, PROCEEDINGS OF THE 35TH INTERNATIONAL CONFERENCE ON SOFTWARE ENGINEERING (ICSE 2013), P712, DOI 10.1109/ICSE.2013.6606617
  • [10] No Issue Left Behind: Reducing Information Overload in Issue Tracking
    Baysal, Olga
    Holmes, Reid
    Godfrey, Michael W.
    [J]. 22ND ACM SIGSOFT INTERNATIONAL SYMPOSIUM ON THE FOUNDATIONS OF SOFTWARE ENGINEERING (FSE 2014), 2014, : 666 - 677