关于 JavaScript 包 README 内容的实证研究
软件工程
2018-02-28 v2
摘要
当代软件项目常利用 README.md 来分享与其软件相关的安装和使用示例等关键信息。此外,这些文件作为软件开发者及潜在用户更新且有用的文档的重要来源。然而,新手与资深开发者有时都不确定一个好的 README 文件需要什么。为理解 README 的内容,我们调查了 43,900 个 JavaScript 包的内容。结果表明这些包包含常见的内容主题(即用法、安装和许可证)。此外,我们发现特定于应用的包更频繁地包含诸如选项等内容主题,而基于库的包更频繁地包含其他特定内容主题(即安装和许可证)。
引用
@article{arxiv.1802.08391,
title = {An Empirical Study on README contents for JavaScript Packages},
author = {Shohei Ikeda and Akinori Ihara and Raula Gaikovina Kula and Kenichi Matsumoto},
journal= {arXiv preprint arXiv:1802.08391},
year = {2018}
}