Comments or Issues: Where to Document Technical Debt?
Fuente:
arXiv
Guardado en:
| Autores principales: | , , |
|---|---|
| Formato: | Preprint |
| Publicado: |
2024
|
| Materias: | |
| Acceso en línea: | |
| Etiquetas: |
Agregar Etiqueta
Sin Etiquetas, Sea el primero en etiquetar este registro!
|
| _version_ | 1866916371765395456 |
|---|---|
| author | Xavier, Laerte Montandon, João Eduardo Valente, Marco Tulio |
| author_facet | Xavier, Laerte Montandon, João Eduardo Valente, Marco Tulio |
| contents | 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. |
| format | Preprint |
| id |
arxiv_https___arxiv_org_abs_2408_15109 |
| institution | arXiv |
| publishDate | 2024 |
| record_format | arxiv |
| spellingShingle | Comments or Issues: Where to Document Technical Debt? Xavier, Laerte Montandon, João Eduardo Valente, Marco Tulio Software Engineering 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. |
| title | Comments or Issues: Where to Document Technical Debt? |
| topic | Software Engineering |
| url | https://arxiv.org/abs/2408.15109 |