Improving the Quality of Commit Messages in Students' Projects

被引:1
作者
Ma, Iris [1 ]
Lopes, Cristina V. [1 ]
机构
[1] Univ Calif Irvine, Dept Informat, Irvine, CA 92717 USA
来源
2023 IEEE/ACM 5TH INTERNATIONAL WORKSHOP ON SOFTWARE ENGINEERING EDUCATION FOR THE NEXT GENERATION, SEENG | 2023年
关键词
Commit message quality; GitHub; Education;
D O I
10.1109/SEENG59157.2023.00005
中图分类号
TP18 [人工智能理论];
学科分类号
081104 ; 0812 ; 0835 ; 1405 ;
摘要
Commit messages play a crucial role in collaborative software development. They provide a clear and concise description of the changes made to the source code. However, many commit messages among students' projects lack useful information. This is a concern, as low-quality commit messages can negatively impact communication of software development and future maintenance. To address this issue, this research aims to help students write high-quality commit messages by "nudging" them in the right direction. We modified the GitHub Desktop application by incorporating specific requirements for commit messages, specifically "what" and "why" parts. To test whether this affects the quality of commit messages, we divided students from an Information Retrieval class into two groups, with one group using the modified application and the other using other interfaces. The results show that the quality of commit messages is improved in terms of informativeness, clearness, and length.
引用
收藏
页码:1 / 4
页数:4
相关论文
共 4 条
[1]   If in Doubt, Try Three: Developing Better Version Control Commit Behaviour with First Year Students [J].
Berg, Amanda ;
Osnes, Simon ;
Glassey, Richard .
PROCEEDINGS OF THE 53RD ACM TECHNICAL SYMPOSIUM ON COMPUTER SCIENCE EDUCATION (SIGCSE 2022), VOL 1, 2022, :362-368
[2]  
Dyer R, 2013, PROCEEDINGS OF THE 35TH INTERNATIONAL CONFERENCE ON SOFTWARE ENGINEERING (ICSE 2013), P422, DOI 10.1109/ICSE.2013.6606588
[3]   Neurala-Machine-Transiation-Based Commit Message Generation: How Far Are We? [J].
Liu, Zhongxin ;
Xia, Xin ;
Hassan, Ahmed E. ;
Lo, David ;
Xing, Zhenchang ;
Wang, Xinyu .
PROCEEDINGS OF THE 2018 33RD IEEE/ACM INTERNATIONAL CONFERENCE ON AUTOMTED SOFTWARE ENGINEERING (ASE' 18), 2018, :373-384
[4]   What Makes a Good Commit Message? [J].
Tian, Yingchen ;
Zhang, Yuxia ;
Stol, Klaas-Jan ;
Jiang, Lin ;
Liu, Hui .
2022 ACM/IEEE 44TH INTERNATIONAL CONFERENCE ON SOFTWARE ENGINEERING (ICSE 2022), 2022, :2389-2401