arXiv Open Access 2024

Comments or Issues: Where to Document Technical Debt?

Laerte Xavier João Eduardo Montandon Marco Tulio Valente

Lihat Sumber

Abstrak

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.

Topik & Kata Kunci

cs.SE

Penulis (3)

Laerte Xavier

João Eduardo Montandon

Marco Tulio Valente

Format Sitasi

APA MLA BibTeX

Xavier, L., Montandon, J.E., Valente, M.T. (2024). Comments or Issues: Where to Document Technical Debt?. https://arxiv.org/abs/2408.15109

Akses Cepat

Lihat di Sumber

Informasi Jurnal

Tahun Terbit: 2024
Bahasa: en
Sumber Database: arXiv
Akses: Open Access ✓