skip to main content
10.1145/3528228.3528408acmconferencesArticle/Chapter ViewAbstractPublication PagesicseConference Proceedingsconference-collections
research-article
Open access

On the adoption of a TODO bot on GitHub: a preliminary study

Published: 26 October 2022 Publication History

Abstract

Bots support different software maintenance and evolution activities, such as code review or executing tests. Recently, several bots have been proposed to help developers to keep track of postponed activities, expressed by means of TODO comments: e.g., TODO Bot automatically creates a GitHub issue when a TODO comment is added to a repository, increasing visibility of TODO comments. In this work, we perform a preliminary evaluation of the impact of the TODO Bot on software development practice. We conjecture that the introduction of the TODO Bot would facilitate keeping track of the TODO comments, and hence encourage developers to use more TODO comments in their code changes.
To evaluate this conjecture, we analyze all the 2,208 repositories which have at least one GitHub issue created by the TODO Bot. Firstly, we investigate to what extent the bot is being used and describe the repositories using the bot. We observe that the majority (54%) of the repositories which adopted the TODO Bot are new, i.e., were created within less than one month of first issue created by the bot, and from those, more than 60% have the issue created within three days. We observe a statistically significant increase in the number of the TODO comments after the adoption of the bot, however with a small effect size. Our results suggest that the adoption of the TODO Bot encourages developers to introduce TODO comments rendering the postponed decisions more visible. Nevertheless, it does not speed up the process of addressing TODO comments or corresponding GitHub issues.

References

[1]
Ahmad Abdellatif, Khaled Badran, and Emad Shihab. [n. d.]. A Repository of Research Articles on Software Bots. http://papers.botse.org.
[2]
David F. Bauer. 1972. Constructing Confidence Sets Using Rank Statistics. J. Amer. Statist. Assoc. 67, 339 (1972), 687--690. http://www.jstor.org/stable/2284469
[3]
Ward Cunningham. 1992. The WyCash Portfolio Management System. In Addendum to the Proceedings on Object-Oriented Programming Systems, Languages, and Applications (Addendum) (Vancouver, British Columbia, Canada) (OOPSLA '92). Association for Computing Machinery, New York, NY, USA, 29--30.
[4]
Jason Etcovitch. [n. d.]. todo. https://github.com/apps/todo
[5]
Martina Iammarino, Fiorella Zampetti, Lerina Aversano, and Massimiliano Di Penta. 2021. An empirical study on the co-occurrence between refactoring actions and Self-Admitted Technical Debt removal. JSS 178 (2021), 110976.
[6]
Eirini Kalliamvakou, Georgios Gousios, Kelly Blincoe, Leif Singer, Daniel M. German, and Daniela Damian. 2014. The Promises and Perils of Mining GitHub. In MSR. ACM, 92--101.
[7]
David G. Kleinbaum and Mitchel Klein. 2005. Survival analysis: A self-learning text. Springer New York.
[8]
Everton Da S. Maldonado, Rabe Abdalkareem, Emad Shihab, and Alexander Serebrenik. 2017. An Empirical Study on the Removal of Self-Admitted Technical Debt. In ICSME. 238--248.
[9]
Pengyu Nie, Rishabh Rai, Junyi Jessy Li, Sarfraz Khurshid, Raymond J. Mooney, and Milos Gligoric. 2019. A Framework for Writing Trigger-Action Todo Comments in Executable Format. In ESEC/FSE. ACM, 385--396.
[10]
Aniket Potdar and Emad Shihab. 2014. An Exploratory Study on Self-Admitted Technical Debt. In ICSME. 91--100.
[11]
J. P. Royston. 1982. An Extension of Shapiro and Wilk's W Test for Normality to Large Samples. Journal of the Royal Statistical Society. Series C (Applied Statistics) 31, 2 (1982), 115--124.
[12]
Davide Spadini, Maurício Aniche, and Alberto Bacchelli. 2018. PyDriller: Python framework for mining software repositories. In Proceedings of the 2018 26th ACM Joint Meeting on European Software Engineering Conference and Symposium on the Foundations of Software Engineering - ESEC/FSE 2018. ACM Press, New York, New York, USA, 908--911.
[13]
Giriprasad Sridhara. 2016. Automatically Detecting the Up-To-Date Status of ToDo Comments in Java Programs. In India Software Engineering Conference. ACM, 16--25.
[14]
Margaret-Anne Storey, Jody Ryall, R. Ian Bull, Del Myers, and Janice Singer. 2008. TODO or to Bug: Exploring How Task Annotations Play a Role in the Work Practices of Software Developers. In ICSE. ACM, 251--260.
[15]
Student. 1908. The probable error of a mean. Biometrika (1908), 1--25.

Cited By

View all

Recommendations

Comments

Information & Contributors

Information

Published In

cover image ACM Conferences
BotSE '22: Proceedings of the Fourth International Workshop on Bots in Software Engineering
May 2022
41 pages
ISBN:9781450393331
DOI:10.1145/3528228
  • Conference Chair:
  • Mairieli Wessel
Permission to make digital or hard copies of all or part of this work for personal or classroom use is granted without fee provided that copies are not made or distributed for profit or commercial advantage and that copies bear this notice and the full citation on the first page. Copyrights for components of this work owned by others than the author(s) must be honored. Abstracting with credit is permitted. To copy otherwise, or republish, to post on servers or to redistribute to lists, requires prior specific permission and/or a fee. Request permissions from [email protected].

Sponsors

In-Cooperation

  • IEEE CS

Publisher

Association for Computing Machinery

New York, NY, United States

Publication History

Published: 26 October 2022

Permissions

Request permissions for this article.

Check for updates

Author Tags

  1. TODO
  2. bots
  3. code comments
  4. technical debt

Qualifiers

  • Research-article

Conference

ICSE '22
Sponsor:

Upcoming Conference

ICSE 2025

Contributors

Other Metrics

Bibliometrics & Citations

Bibliometrics

Article Metrics

  • Downloads (Last 12 months)114
  • Downloads (Last 6 weeks)17
Reflects downloads up to 09 Feb 2025

Other Metrics

Citations

Cited By

View all

View Options

View options

PDF

View or Download as a PDF file.

PDF

eReader

View online with eReader.

eReader

Login options

Figures

Tables

Media

Share

Share

Share this Publication link

Share on social media