Published November 24, 2021 | Version v1
Journal article Open

Comments or Issues: Where to Document Technical Debt?

Creators

  • 1. Federal University of Minas Gerais, Brazil

Description

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 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.

Files

overview_dataset.csv

Files (36.8 MB)

Name Size Download all
md5:fd1362316d9cc074124db90b3d273637
8.5 kB Preview Download
md5:561bec2d103f20fe44f31978fe274bcf
33.6 MB Preview Download
md5:36d9164dc266141946529e03b036eeaa
3.0 MB Preview Download
md5:9c75f833a0032e2e0a46cf605d292290
130.1 kB Preview Download