An Empirical Study of README contents for Java']JavaScript Packages

被引：5
|
作者：
Ikeda, Shohei [1 ]
Ihara, Akinori [1 ,2 ]
Kula, Raula Gaikovina [1 ]
Matsumoto, Kenichi [1 ]
机构：
[1] Nara Inst Sci & Technol NAIST, Grad Sch Informat Sci, Ikoma 6300192, Japan
[2] Wakayama Univ, Fac Syst Engn, Wakayama 6408510, Japan
来源：
IEICE TRANSACTIONS ON INFORMATION AND SYSTEMS | 2019年 / E102D卷 / 02期
关键词：
documentation; README; association rule mining; !text type='Java']Java[!/text]Script packages;
D O I：
10.1587/transinf.2018EDP7071
中图分类号：
TP [自动化技术、计算机技术];
学科分类号：
0812 ;
摘要：
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').
引用
收藏
页码：280 / 288
页数：9
相关论文
共 50 条
  • [1] On the Untriviality of Trivial Packages: An Empirical Study of npm Java']JavaScript Packages
    Chowdhury, Md Atique Reza
    Abdalkareem, Rabe
    Shihab, Emad
    Adams, Bram
    IEEE TRANSACTIONS ON SOFTWARE ENGINEERING, 2022, 48 (08) : 2695 - 2708
  • [2] Java']JavaScript Errors in the Wild: An Empirical Study
    Ocariza, Frolin S., Jr.
    Pattabiraman, Karthik
    Zorn, Benjamin
    22ND IEEE INTERNATIONAL SYMPOSIUM ON SOFTWARE RELIABILITY ENGINEERING (ISSRE), 2011, : 100 - 109
  • [3] An empirical study on bugs in Java']JavaScript engines
    Wang, Ziyuan
    Bu, Dexin
    Wang, Nannan
    Yu, Sijie
    Gou, Shanyi
    Sun, Aiyue
    INFORMATION AND SOFTWARE TECHNOLOGY, 2023, 155
  • [4] An Empirical Study of Flaky Tests in Java']JavaScript
    Hashemi, Negar
    Tahir, Amjed
    Rasheed, Shawn
    2022 IEEE INTERNATIONAL CONFERENCE ON SOFTWARE MAINTENANCE AND EVOLUTION (ICSME 2022), 2022, : 24 - 34
  • [5] Empirical study of the dynamic behavior of Java']JavaScript objects
    Wei, Shiyi
    Xhakaj, Franceska
    Ryder, Barbara G.
    SOFTWARE-PRACTICE & EXPERIENCE, 2016, 46 (07): : 867 - 889
  • [6] Performance Issues and Optimizations in Java']JavaScript: An Empirical Study
    Selakovic, Marija
    Pradel, Michael
    2016 IEEE/ACM 38TH INTERNATIONAL CONFERENCE ON SOFTWARE ENGINEERING (ICSE), 2016, : 61 - 72
  • [7] An Empirical Study of Code Smells in Java']JavaScript Projects
    Saboury, Amir
    Musavi, Pooya
    Khomh, Foutse
    Antoniol, Giulio
    2017 IEEE 24TH INTERNATIONAL CONFERENCE ON SOFTWARE ANALYSIS, EVOLUTION, AND REENGINEERING (SANER), 2017, : 294 - 305
  • [8] On the impact of micro-packages: An empirical study of the npm javascript ecosystem
    2017, arXiv
  • [9] Understanding Popularity Growth of Packages in Java']JavaScript Package Ecosystem
    Qiu, Shi
    Kula, Raula Gaikovina
    Inoue, Katsuro
    2018 IEEE/ACIS 3RD INTERNATIONAL CONFERENCE ON BIG DATA, CLOUD COMPUTING, DATA SCIENCE & ENGINEERING (BCD 2018), 2018, : 55 - 60
  • [10] On the Impact of Outdated and Vulnerable Java']Javascript Packages in Docker Images
    Zerouali, Ahmed
    Cosentino, Valerio
    Mens, Tom
    Robles, Gregorio
    Gonzalez-Barahona, Jesus M.
    2019 IEEE 26TH INTERNATIONAL CONFERENCE ON SOFTWARE ANALYSIS, EVOLUTION AND REENGINEERING (SANER), 2019, : 619 - 623
12345