An Empirical Study of README contents for JavaScript Packages

• IKEDA Shohei

  Graduate School of Information Science, Nara Institute of Science and Technology (NAIST)

• IHARA Akinori

  Graduate School of Information Science, Nara Institute of Science and Technology (NAIST) Faculty of System Engineering, Wakayama University

• KULA Raula Gaikovina

  Graduate School of Information Science, Nara Institute of Science and Technology (NAIST)

• MATSUMOTO Kenichi

  Graduate School of Information Science, Nara Institute of Science and Technology (NAIST)

抄録

Contemporary software projects often utilize a README.md to share crucial information such as installation and usage examples related to their software. Furthermore, these files serve as an important source of updated and useful documentation for developers and prospective users of the software. Nonetheless, both novice and seasoned developers are sometimes unsure of what is required for a good README file. To understand the contents of README, we investigate the contents of 43,900 JavaScript packages. Results show that these packages contain common content themes (i.e., ‘usage’, ‘install’ and ‘license’). Furthermore, we find that application-specific packages more frequently included content themes such as ‘options’, while library-based packages more frequently included other specific content themes (i.e., ‘install’ and ‘license’).

収録刊行物

• IEICE Transactions on Information and Systems

  IEICE Transactions on Information and Systems E102.D (2), 280-288, 2019-02-01

  一般社団法人 電子情報通信学会

キーワード

• documentation
• README
• association rule mining
• JavaScript packages

詳細情報

• CRID: 1390001288118888704
• NII論文ID: 130007588867
• DOI: 10.1587/transinf.2018edp7071
• ISSN: 17451361
• ISSN: 09168532
• Web Site: https://www.jstage.jst.go.jp/article/transinf/E102.D/2/E102.D_2018EDP7071/_pdf
• 本文言語コード: en
• データソース種別:
  • JaLC
  • Crossref
  • CiNii Articles
  • KAKEN
• 抄録ライセンスフラグ: 使用不可