Skip to main content
OSTI.GOVU.S. Department of Energy Office of Scientific and Technical Information
U.S. Department of Energy
Office of Scientific and Technical Information
 

Templates for developing and versioning data standards and reporting formats using GitHub

Dataset ·
DOI:https://doi.org/10.15485/1780564· OSTI ID:1780564
 [1];  [2];  [3];  [4];  [2];  [5];  [6];  [2];  [6];  [7];  [3];  [6];  [2];  [2];  [3];  [2];  [7];  [2];  [6];  [2] more »;  [8];  [6];  [2] « less
  1. Lawrence Berkeley National Laboratory; Lawrence Berkeley National Laboratory
  2. Lawrence Berkeley National Laboratory
  3. Pacific Northwest National Laboratory (PNNL)
  4. SLAC National Accelerator Laboratory
  5. Lawrence Berkeley National Lab - NERSC
  6. Oak Ridge National Laboratory
  7. Brookhaven National Lab
  8. Argonne National Laboratory
+ Show Author Affiliations

This data package contains three templates that can be used for creating README files and Issue Templates, written in the markdown language, that support community-led data reporting formats. We created these templates based on the results of a systematic review (see related references) that explored how groups developing data standard documentation use the Version Control platform GitHub, to collaborate on supporting documents. Based on our review of 32 GitHub repositories, we make recommendations for the content of README Files (e.g., provide a user license, indicate how users can contribute) and so 'README_template.md' includes headings for each section. The two issue templates we include ('issue_template_for_all_other_changes.md' and 'issue_template_for_documentation_change.md') can be used in a GitHub repository to help structure user-submitted issues, or can be modified to suit the needs of data standard developers. We used these templates when establishing ESS-DIVE's community space on GitHub (https://github.com/ess-dive-community) that includes documentation for community-led data reporting formats. We also include file-level metadata 'flmd.csv' that describes the contents of each file within this data package. Lastly, the temporal range that we indicate in our metadata is the time range during which we searched for data standards documented on GitHub.

Research Organization:
Environmental System Science Data Infrastructure for a Virtual Ecosystem; Environmental Systems Science Data Infrastructure for a Virtual Ecosystem
Sponsoring Organization:
U.S. DOE > Office of Science > Biological and Environmental Research (BER)
OSTI ID:
1780564
Country of Publication:
United States
Language:
English

Similar Records

ESS-DIVE Unoccupied Aerial Systems (UAS) Reporting Format v1
Dataset · Sat Dec 31 23:00:00 EST 2022 · OSTI ID:2204420
Data from: "A guide to using GitHub for developing and versioning data standards and reporting formats"
Dataset · Thu Dec 31 23:00:00 EST 2020 · OSTI ID:1780565
ESS-DIVE Reporting Format for File-level Metadata
Dataset · Thu Dec 31 23:00:00 EST 2020 · OSTI ID:1734840

Related Subjects

54 ENVIRONMENTAL SCIENCES
FAIR data
data reporting formats
data repositories
data standards
metadata
open science
trust principles