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.

Dataset Files

You must be an IEEE Dataport Subscriber to access these files. Subscribe now or login.

[1] Laerte Xavier, João Eduardo Montandon, Marco Tulio Valente, "Comments or Issues: Where to Document Technical Debt?", IEEE Dataport, 2021. [Online]. Available: http://dx.doi.org/10.21227/xxqj-1w30. Accessed: Jan. 18, 2022.
@data{xxqj-1w30-21,
doi = {10.21227/xxqj-1w30},
url = {http://dx.doi.org/10.21227/xxqj-1w30},
author = {Laerte Xavier; João Eduardo Montandon; Marco Tulio Valente },
publisher = {IEEE Dataport},
title = {Comments or Issues: Where to Document Technical Debt?},
year = {2021} }
TY - DATA
T1 - Comments or Issues: Where to Document Technical Debt?
AU - Laerte Xavier; João Eduardo Montandon; Marco Tulio Valente
PY - 2021
PB - IEEE Dataport
UR - 10.21227/xxqj-1w30
ER -
Laerte Xavier, João Eduardo Montandon, Marco Tulio Valente. (2021). Comments or Issues: Where to Document Technical Debt?. IEEE Dataport. http://dx.doi.org/10.21227/xxqj-1w30
Laerte Xavier, João Eduardo Montandon, Marco Tulio Valente, 2021. Comments or Issues: Where to Document Technical Debt?. Available at: http://dx.doi.org/10.21227/xxqj-1w30.
Laerte Xavier, João Eduardo Montandon, Marco Tulio Valente. (2021). "Comments or Issues: Where to Document Technical Debt?." Web.
1. Laerte Xavier, João Eduardo Montandon, Marco Tulio Valente. Comments or Issues: Where to Document Technical Debt? [Internet]. IEEE Dataport; 2021. Available from : http://dx.doi.org/10.21227/xxqj-1w30
Laerte Xavier, João Eduardo Montandon, Marco Tulio Valente. "Comments or Issues: Where to Document Technical Debt?." doi: 10.21227/xxqj-1w30