The Introduction of README and CONTRIBUTING Files in Open Source Software Development

• URL: http://arxiv.org/abs/2502.18440v2
• Date: Fri, 14 Mar 2025 17:00:28 GMT
• Title: The Introduction of README and CONTRIBUTING Files in Open Source Software Development
• Authors: Matthew Gaughan, Kaylea Champion, Sohyeon Hwang, Aaron Shaw,
• Abstract summary: CONTRIBUTING files can serve as the first point of contact for potential contributors to free/libre and open source software (FLOSS) projects.<n>Prominent open source software organizations such as Mozilla, GitHub, and the Linux Foundation advocate that projects provide community-focused and process-oriented documentation early to foster recruitment and activity.
• Score: 1.5024443617567174
• License: http://creativecommons.org/licenses/by-sa/4.0/
• Abstract: README and CONTRIBUTING files can serve as the first point of contact for potential contributors to free/libre and open source software (FLOSS) projects. Prominent open source software organizations such as Mozilla, GitHub, and the Linux Foundation advocate that projects provide community-focused and process-oriented documentation early to foster recruitment and activity. In this paper we investigate the introduction of these documents in FLOSS projects, including whether early documentation conforms to these recommendations or explains subsequent activity. We use a novel dataset of FLOSS projects packaged by the Debian GNU/Linux distribution and conduct a quantitative analysis to examine README (n=4226) and CONTRIBUTING (n=714) files when they are first published into projects' repositories. We find that projects create minimal READMEs proactively, but often publish CONTRIBUTING files following an influx of contributions. The initial versions of these files rarely focus on community development, instead containing descriptions of project procedure for library usage or code contribution. The findings suggest that FLOSS projects do not create documentation with community-building in mind, but rather favor brevity and standardized instructions.

Related papers

• Free and Customizable Code Documentation with LLMs: A Fine-Tuning Approach [0.0]
  We present a large language model (LLM)-based application that developers can use as a support tool to generate basic documentation for any publicly available repository.
  arXiv  Detail & Related papers  (2024-12-01T08:38:18Z)
• DOCBENCH: A Benchmark for Evaluating LLM-based Document Reading Systems [99.17123445211115]
  We introduce DocBench, a benchmark to evaluate large language model (LLM)-based document reading systems. Our benchmark involves the recruitment of human annotators and the generation of synthetic questions. It includes 229 real documents and 1,102 questions, spanning across five different domains and four major types of questions.
  arXiv  Detail & Related papers  (2024-07-15T13:17:42Z)
• FAIR-USE4OS: Guidelines for Creating Impactful Open-Source Software [0.41942958779358663]
  This paper extends the FAIR (Findable, Accessible, Interoperable, Reusable) guidelines to provide criteria for assessing if software conforms to best practices in open source. The FAIR-USE4OS guidelines will allow funders and researchers to more effectively evaluate and plan open source software projects.
  arXiv  Detail & Related papers  (2024-02-05T09:15:20Z)
• DevEval: Evaluating Code Generation in Practical Software Projects [52.16841274646796]
  We propose a new benchmark named DevEval, aligned with Developers' experiences in practical projects. DevEval is collected through a rigorous pipeline, containing 2,690 samples from 119 practical projects. We assess five popular LLMs on DevEval and reveal their actual abilities in code generation.
  arXiv  Detail & Related papers  (2024-01-12T06:51:30Z)
• Adapting Installation Instructions in Rapidly Evolving Software Ecosystems [9.982895603207993]
  We conducted a study investigating GitHub repositories with 1,163 commits that focused on updates in installation-related sections.<n>Our research revealed six major categories of changes in the commits, namely pre-installation instructions, installation instructions post-installation instructions, document presentation, and external resource management.<n>We propose a template to cover installation-related sections for documentation maintainers to reference when updating documents.
  arXiv  Detail & Related papers  (2023-12-06T02:54:26Z)
• CodeTF: One-stop Transformer Library for State-of-the-art Code LLM [72.1638273937025]
  We present CodeTF, an open-source Transformer-based library for state-of-the-art Code LLMs and code intelligence. Our library supports a collection of pretrained Code LLM models and popular code benchmarks. We hope CodeTF is able to bridge the gap between machine learning/generative AI and software engineering.
  arXiv  Detail & Related papers  (2023-05-31T05:24:48Z)
• Code Recommendation for Open Source Software Developers [32.181023933552694]
  CODER is a novel graph-based code recommendation framework for open source software developers. Our framework achieves superior performance under various experimental settings, including intra-project, cross-project, and cold-start recommendation.
  arXiv  Detail & Related papers  (2022-10-15T16:40:36Z)
• Code Librarian: A Software Package Recommendation System [65.05559087332347]
  We present a recommendation engine called Librarian for open source libraries. A candidate library package is recommended for a given context if: 1) it has been frequently used with the imported libraries in the program; 2) it has similar functionality to the imported libraries in the program; 3) it has similar functionality to the developer's implementation, and 4) it can be used efficiently in the context of the provided code.
  arXiv  Detail & Related papers  (2022-10-11T12:30:05Z)
• LAGOON: An Analysis Tool for Open Source Communities [7.3861897382622015]
  LAGOON is an open source platform for understanding the ecosystems of Open Source Software (OSS) communities. LAGOON ingests artifacts from several common sources, including source code repositories, issue trackers, mailing lists and scraping content from websites. A user interface is provided for visualization and exploration of an OSS project's complete sociotechnical graph.
  arXiv  Detail & Related papers  (2022-01-26T18:52:11Z)
• YMIR: A Rapid Data-centric Development Platform for Vision Applications [82.67319997259622]
  This paper introduces an open source platform for rapid development of computer vision applications. The platform puts the efficient data development at the center of the machine learning development process.
  arXiv  Detail & Related papers  (2021-11-19T05:02:55Z)
• Towards Utility-based Prioritization of Requirements in Open Source Environments [51.65930505153647]
  We show how utility-based prioritization approaches can be used to support contributors in conventional and open source Requirements Engineering scenarios. As an example, we show how dependencies can be taken into account in utility-based prioritization processes.
  arXiv  Detail & Related papers  (2021-02-17T09:05:54Z)

This list is automatically generated from the titles and abstracts of the papers in this site.

This site does not guarantee the quality of this site (including all information) and is not responsible for any consequences.