GitHub README 文件内容分类
软件工程
2018-07-31 v2
摘要
README 文件在塑造开发者对软件仓库的第一印象以及记录该仓库所承载的软件项目方面起着至关重要的作用。然而，我们缺乏对典型 README 文件内容的系统性理解，也缺乏能够自动处理这些文件的工具。为弥补这一空白，我们进行了一项定性研究，涉及对从 393 个随机抽样的 GitHub 仓库中获得的 4,226 个 README 文件章节的人工标注，并设计及评估了一个分类器及一组可自动对这些章节进行分类的特征。我们发现，讨论仓库‘是什么’和‘怎么做’的信息非常普遍，而许多 README 文件缺乏关于仓库目的和状态的信息。我们可预测八种不同类别的多标签分类器达到了 0.746 的 F1 分数。为评估分类的实用性，我们使用自动确定的类别通过徽章对 GitHub README 文件中的章节进行标注，并向二十位软件专业人员展示了带与不带这些徽章的文件。大多数参与者认为基于我们分类器的章节自动标注减轻了信息发现的难度。该工作使软件仓库所有者能够提升其文档质量，并有可能使软件开发社区更容易在 GitHub README 文件中发现相关信息。
引用
@article{arxiv.1802.06997,
title = {Categorizing the Content of GitHub README Files},
author = {Gede Artha Azriadi Prana and Christoph Treude and Ferdian Thung and Thushari Atapattu and David Lo},
journal= {arXiv preprint arXiv:1802.06997},
year = {2018}
}