2019
DOI: 10.1587/transinf.2018edp7071
|View full text |Cite
|
Sign up to set email alerts
|

An Empirical Study of README contents for JavaScript Packages

Abstract: 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. Result… Show more

Help me understand this report

Search citation statements

Order By: Relevance

Paper Sections

Select...
2
1

Citation Types

0
3
0

Year Published

2020
2020
2023
2023

Publication Types

Select...
3
3

Relationship

1
5

Authors

Journals

citations
Cited by 6 publications
(3 citation statements)
references
References 12 publications
0
3
0
Order By: Relevance
“…• Metadata files: One of the README, LICENSE, and COPYING files in the top-level directory of the OSS ([23], [24]).…”
Section: A Accuracy O F Centrismentioning
confidence: 99%
“…• Metadata files: One of the README, LICENSE, and COPYING files in the top-level directory of the OSS ([23], [24]).…”
Section: A Accuracy O F Centrismentioning
confidence: 99%
“…• Metadata files: One of the README, LICENSE, and COPYING files in the top-level directory of the OSS ( [23], [24]).…”
Section: A Accuracy Of Centrismentioning
confidence: 99%
“…This result indicates that project contributors consider links as an important instrument to provide further details about their projects. Ikeda et al [22] performed a similar study to evaluate README.md contents. Inspired by these works, we initiated our investigation on the relationship between academic papers and the scientific projects hosted on GitHub through the reference links embedded in their project README.md files.…”
Section: Related Workmentioning
confidence: 99%