1. Comments or Issues: Where to Document Technical Debt
- Author
-
Laerte Xavier, Joao Eduardo Montandon, and Marco Tulio Valente
- Subjects
Issue Trackers ,Code Comments ,Technical Debt ,Software - Abstract
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 drivedevelopers 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 from190 GitHub projects. As a result, we provide 13 guidelines to support developers to decide when to use comments or issues to reportTechnical Debt.
- Published
- 2022
- Full Text
- View/download PDF