- Main
A Guide to Using GitHub for Developing and Versioning Data Standards and Reporting Formats
- Crystal‐Ornelas, Robert;
- Varadharajan, Charuleka;
- Bond‐Lamberty, Ben;
- Boye, Kristin;
- Burrus, Madison;
- Cholia, Shreyas;
- Crow, Michael;
- Damerow, Joan;
- Devarakonda, Ranjeet;
- Ely, Kim S;
- Goldman, Amy;
- Heinz, Susan;
- Hendrix, Valerie;
- Kakalia, Zarine;
- Pennington, Stephanie C;
- Robles, Emily;
- Rogers, Alistair;
- Simmonds, Maegen;
- Velliquette, Terri;
- Weierbach, Helen;
- Weisenhorn, Pamela;
- Welch, Jessica N;
- Agarwal, Deborah A
Published Web Location
https://doi.org/10.1029/2021ea001797Abstract
Abstract Data standardization combined with descriptive metadata facilitate data reuse, which is the ultimate goal of the Findable, Accessible, Interoperable, and Reusable (FAIR) principles. Community data or metadata standards are increasingly created through an approach that emphasizes collaboration between various stakeholders. Such an approach requires platforms for collaboration on the development process that centers on sharing information and receiving feedback. Our objective in this study was to conduct a systematic review to identify data standards and reporting formats that use version control for developing data standards and to summarize common practices, particularly in earth and environmental sciences. Out of 108 data standards and reporting formats identified in our review, 32 used GitHub as the version control platform, and no other platforms were used. We found no universally accepted methodology for developing and publishing data standards. Many GitHub repositories did not use key features that could help developers to gather user feedback, or to create and revise standards that build on previous work. We provide guidance for community‐driven standard development and associated documentation on GitHub based on a systematic review of existing practices. Key Points Developing data standards on Version Control System platforms like GitHub enables collaboration and transparency Many standards do not use tools for collaboration: issue tracking, licensing, and automated website hosting (GitBook or GitHub Pages) We make recommendations and provide templates for creating descriptive version‐controlled data standard documentation on GitHub
Many UC-authored scholarly publications are freely available on this site because of the UC's open access policies. Let us know how this access is important for you.