Comments or Issues: Where to Document Technical Debt?

Autor: Xavier, Laerte, Montandon, João Eduardo, Valente, Marco Tulio
Rok vydání: 2024
Předmět:
Zdroj: IEEE Software 39.5 (2022)
Druh dokumentu: Working Paper
DOI: 10.1109/MS.2022.3170825
Popis: Self-Admitted Technical Debt (SATD) is a form of Technical Debt where developers document the debt using source code comments (SATD-C) or issues (SATD-I). However, it is still unclear the circumstances that drive developers to choose one or another. In this paper, we survey authors of both types of debts using a large-scale dataset containing 74K SATD-C and 20K SATD-I instances, extracted from 190 GitHub projects. As a result, we provide 13 guidelines to support developers to decide when to use comments or issues to report Technical Debt.
Databáze: arXiv