A Guide to Using GitHub for Developing and Versioning Data Standards and Reporting Formats. Crystal‐Ornelas, R., Varadharajan, C., Bond‐Lamberty, B., Boye, K., Burrus, M., Cholia, S., Crow, M., Damerow, J., Devarakonda, R., Ely, K. S., Goldman, A., Heinz, S., Hendrix, V., Kakalia, Z., Pennington, S. C., Robles, E., Rogers, A., Simmonds, M., Velliquette, T., Weierbach, H., Weisenhorn, P., Welch, J. N., & Agarwal, D. A. Earth and Space Science, 8(8):e2021EA001797, August, 2021. 🏷️ /unreadPaper doi abstract bibtex 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 【摘要翻译】摘要 数据标准化与描述性元数据相结合有助于数据的重复使用,这也是可查找、可访问、可互操作和可重复使用(FAIR)原则的最终目标。越来越多的社区数据或元数据标准是通过强调各利益相关方之间合作的方法创建的。这种方法要求在开发过程中建立以共享信息和接收反馈为中心的合作平台。本研究的目的是进行系统性回顾,以确定使用版本控制来制定数据标准的数据标准和报告格式,并总结常见做法,尤其是地球和环境科学领域的常见做法。在我们审查确定的 108 个数据标准和报告格式中,有 32 个使用 GitHub 作为版本控制平台,没有使用其他平台。我们发现,在制定和发布数据标准方面没有普遍接受的方法。许多 GitHub 资源库没有使用关键功能,而这些功能可以帮助开发人员收集用户反馈,或在先前工作的基础上创建和修订标准。我们在对现有实践进行系统回顾的基础上,为 GitHub 上社区驱动的标准开发和相关文档提供了指导。 , 要点 在 GitHub 等版本控制系统平台上制定数据标准可实现协作和透明度 许多标准没有使用协作工具:问题跟踪、许可和自动网站托管(GitBook 或 GitHub Pages) 我们为在 GitHub 上创建描述性版本控制数据标准文档提出建议并提供模板
@article{crystal-ornelas2021,
title = {A {Guide} to {Using} {GitHub} for {Developing} and {Versioning} {Data} {Standards} and {Reporting} {Formats}},
volume = {8},
issn = {2333-5084, 2333-5084},
shorttitle = {使用 {GitHub} 开发和版本控制数据标准和报告格式指南},
url = {https://agupubs.onlinelibrary.wiley.com/doi/10.1029/2021EA001797},
doi = {10.1029/2021EA001797},
abstract = {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
【摘要翻译】摘要
数据标准化与描述性元数据相结合有助于数据的重复使用,这也是可查找、可访问、可互操作和可重复使用(FAIR)原则的最终目标。越来越多的社区数据或元数据标准是通过强调各利益相关方之间合作的方法创建的。这种方法要求在开发过程中建立以共享信息和接收反馈为中心的合作平台。本研究的目的是进行系统性回顾,以确定使用版本控制来制定数据标准的数据标准和报告格式,并总结常见做法,尤其是地球和环境科学领域的常见做法。在我们审查确定的 108 个数据标准和报告格式中,有 32 个使用 GitHub 作为版本控制平台,没有使用其他平台。我们发现,在制定和发布数据标准方面没有普遍接受的方法。许多 GitHub 资源库没有使用关键功能,而这些功能可以帮助开发人员收集用户反馈,或在先前工作的基础上创建和修订标准。我们在对现有实践进行系统回顾的基础上,为 GitHub 上社区驱动的标准开发和相关文档提供了指导。
,
要点
在 GitHub 等版本控制系统平台上制定数据标准可实现协作和透明度
许多标准没有使用协作工具:问题跟踪、许可和自动网站托管(GitBook 或 GitHub Pages)
我们为在 GitHub 上创建描述性版本控制数据标准文档提出建议并提供模板},
language = {en},
number = {8},
urldate = {2024-12-07},
journal = {Earth and Space Science},
author = {Crystal‐Ornelas, Robert and Varadharajan, Charuleka and Bond‐Lamberty, Ben and Boye, Kristin and Burrus, Madison and Cholia, Shreyas and Crow, Michael and Damerow, Joan and Devarakonda, Ranjeet and Ely, Kim S. and Goldman, Amy and Heinz, Susan and Hendrix, Valerie and Kakalia, Zarine and Pennington, Stephanie C. and Robles, Emily and Rogers, Alistair and Simmonds, Maegen and Velliquette, Terri and Weierbach, Helen and Weisenhorn, Pamela and Welch, Jessica N. and Agarwal, Deborah A.},
month = aug,
year = {2021},
note = {🏷️ /unread},
keywords = {/unread},
pages = {e2021EA001797},
}
Downloads: 0
{"_id":"3DQeT6uorn7KWw7vJ","bibbaseid":"crystalornelas-varadharajan-bondlamberty-boye-burrus-cholia-crow-damerow-etal-aguidetousinggithubfordevelopingandversioningdatastandardsandreportingformats-2021","author_short":["Crystal‐Ornelas, R.","Varadharajan, C.","Bond‐Lamberty, B.","Boye, K.","Burrus, M.","Cholia, S.","Crow, M.","Damerow, J.","Devarakonda, R.","Ely, K. S.","Goldman, A.","Heinz, S.","Hendrix, V.","Kakalia, Z.","Pennington, S. C.","Robles, E.","Rogers, A.","Simmonds, M.","Velliquette, T.","Weierbach, H.","Weisenhorn, P.","Welch, J. N.","Agarwal, D. A."],"bibdata":{"bibtype":"article","type":"article","title":"A Guide to Using GitHub for Developing and Versioning Data Standards and Reporting Formats","volume":"8","issn":"2333-5084, 2333-5084","shorttitle":"使用 GitHub 开发和版本控制数据标准和报告格式指南","url":"https://agupubs.onlinelibrary.wiley.com/doi/10.1029/2021EA001797","doi":"10.1029/2021EA001797","abstract":"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 【摘要翻译】摘要 数据标准化与描述性元数据相结合有助于数据的重复使用,这也是可查找、可访问、可互操作和可重复使用(FAIR)原则的最终目标。越来越多的社区数据或元数据标准是通过强调各利益相关方之间合作的方法创建的。这种方法要求在开发过程中建立以共享信息和接收反馈为中心的合作平台。本研究的目的是进行系统性回顾,以确定使用版本控制来制定数据标准的数据标准和报告格式,并总结常见做法,尤其是地球和环境科学领域的常见做法。在我们审查确定的 108 个数据标准和报告格式中,有 32 个使用 GitHub 作为版本控制平台,没有使用其他平台。我们发现,在制定和发布数据标准方面没有普遍接受的方法。许多 GitHub 资源库没有使用关键功能,而这些功能可以帮助开发人员收集用户反馈,或在先前工作的基础上创建和修订标准。我们在对现有实践进行系统回顾的基础上,为 GitHub 上社区驱动的标准开发和相关文档提供了指导。 , 要点 在 GitHub 等版本控制系统平台上制定数据标准可实现协作和透明度 许多标准没有使用协作工具:问题跟踪、许可和自动网站托管(GitBook 或 GitHub Pages) 我们为在 GitHub 上创建描述性版本控制数据标准文档提出建议并提供模板","language":"en","number":"8","urldate":"2024-12-07","journal":"Earth and Space Science","author":[{"propositions":[],"lastnames":["Crystal‐Ornelas"],"firstnames":["Robert"],"suffixes":[]},{"propositions":[],"lastnames":["Varadharajan"],"firstnames":["Charuleka"],"suffixes":[]},{"propositions":[],"lastnames":["Bond‐Lamberty"],"firstnames":["Ben"],"suffixes":[]},{"propositions":[],"lastnames":["Boye"],"firstnames":["Kristin"],"suffixes":[]},{"propositions":[],"lastnames":["Burrus"],"firstnames":["Madison"],"suffixes":[]},{"propositions":[],"lastnames":["Cholia"],"firstnames":["Shreyas"],"suffixes":[]},{"propositions":[],"lastnames":["Crow"],"firstnames":["Michael"],"suffixes":[]},{"propositions":[],"lastnames":["Damerow"],"firstnames":["Joan"],"suffixes":[]},{"propositions":[],"lastnames":["Devarakonda"],"firstnames":["Ranjeet"],"suffixes":[]},{"propositions":[],"lastnames":["Ely"],"firstnames":["Kim","S."],"suffixes":[]},{"propositions":[],"lastnames":["Goldman"],"firstnames":["Amy"],"suffixes":[]},{"propositions":[],"lastnames":["Heinz"],"firstnames":["Susan"],"suffixes":[]},{"propositions":[],"lastnames":["Hendrix"],"firstnames":["Valerie"],"suffixes":[]},{"propositions":[],"lastnames":["Kakalia"],"firstnames":["Zarine"],"suffixes":[]},{"propositions":[],"lastnames":["Pennington"],"firstnames":["Stephanie","C."],"suffixes":[]},{"propositions":[],"lastnames":["Robles"],"firstnames":["Emily"],"suffixes":[]},{"propositions":[],"lastnames":["Rogers"],"firstnames":["Alistair"],"suffixes":[]},{"propositions":[],"lastnames":["Simmonds"],"firstnames":["Maegen"],"suffixes":[]},{"propositions":[],"lastnames":["Velliquette"],"firstnames":["Terri"],"suffixes":[]},{"propositions":[],"lastnames":["Weierbach"],"firstnames":["Helen"],"suffixes":[]},{"propositions":[],"lastnames":["Weisenhorn"],"firstnames":["Pamela"],"suffixes":[]},{"propositions":[],"lastnames":["Welch"],"firstnames":["Jessica","N."],"suffixes":[]},{"propositions":[],"lastnames":["Agarwal"],"firstnames":["Deborah","A."],"suffixes":[]}],"month":"August","year":"2021","note":"🏷️ /unread","keywords":"/unread","pages":"e2021EA001797","bibtex":"@article{crystal-ornelas2021,\n\ttitle = {A {Guide} to {Using} {GitHub} for {Developing} and {Versioning} {Data} {Standards} and {Reporting} {Formats}},\n\tvolume = {8},\n\tissn = {2333-5084, 2333-5084},\n\tshorttitle = {使用 {GitHub} 开发和版本控制数据标准和报告格式指南},\n\turl = {https://agupubs.onlinelibrary.wiley.com/doi/10.1029/2021EA001797},\n\tdoi = {10.1029/2021EA001797},\n\tabstract = {Abstract \n 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. \n , \n Key Points \n \n \n \n Developing data standards on Version Control System platforms like GitHub enables collaboration and transparency \n \n \n Many standards do not use tools for collaboration: issue tracking, licensing, and automated website hosting (GitBook or GitHub Pages) \n \n \n We make recommendations and provide templates for creating descriptive version‐controlled data standard documentation on GitHub\n\n【摘要翻译】摘要\n 数据标准化与描述性元数据相结合有助于数据的重复使用,这也是可查找、可访问、可互操作和可重复使用(FAIR)原则的最终目标。越来越多的社区数据或元数据标准是通过强调各利益相关方之间合作的方法创建的。这种方法要求在开发过程中建立以共享信息和接收反馈为中心的合作平台。本研究的目的是进行系统性回顾,以确定使用版本控制来制定数据标准的数据标准和报告格式,并总结常见做法,尤其是地球和环境科学领域的常见做法。在我们审查确定的 108 个数据标准和报告格式中,有 32 个使用 GitHub 作为版本控制平台,没有使用其他平台。我们发现,在制定和发布数据标准方面没有普遍接受的方法。许多 GitHub 资源库没有使用关键功能,而这些功能可以帮助开发人员收集用户反馈,或在先前工作的基础上创建和修订标准。我们在对现有实践进行系统回顾的基础上,为 GitHub 上社区驱动的标准开发和相关文档提供了指导。\n ,\n 要点\n \n \n \n 在 GitHub 等版本控制系统平台上制定数据标准可实现协作和透明度\n \n \n 许多标准没有使用协作工具:问题跟踪、许可和自动网站托管(GitBook 或 GitHub Pages)\n \n \n 我们为在 GitHub 上创建描述性版本控制数据标准文档提出建议并提供模板},\n\tlanguage = {en},\n\tnumber = {8},\n\turldate = {2024-12-07},\n\tjournal = {Earth and Space Science},\n\tauthor = {Crystal‐Ornelas, Robert and Varadharajan, Charuleka and Bond‐Lamberty, Ben and Boye, Kristin and Burrus, Madison and Cholia, Shreyas and Crow, Michael and Damerow, Joan and Devarakonda, Ranjeet and Ely, Kim S. and Goldman, Amy and Heinz, Susan and Hendrix, Valerie and Kakalia, Zarine and Pennington, Stephanie C. and Robles, Emily and Rogers, Alistair and Simmonds, Maegen and Velliquette, Terri and Weierbach, Helen and Weisenhorn, Pamela and Welch, Jessica N. and Agarwal, Deborah A.},\n\tmonth = aug,\n\tyear = {2021},\n\tnote = {🏷️ /unread},\n\tkeywords = {/unread},\n\tpages = {e2021EA001797},\n}\n\n","author_short":["Crystal‐Ornelas, R.","Varadharajan, C.","Bond‐Lamberty, B.","Boye, K.","Burrus, M.","Cholia, S.","Crow, M.","Damerow, J.","Devarakonda, R.","Ely, K. S.","Goldman, A.","Heinz, S.","Hendrix, V.","Kakalia, Z.","Pennington, S. C.","Robles, E.","Rogers, A.","Simmonds, M.","Velliquette, T.","Weierbach, H.","Weisenhorn, P.","Welch, J. N.","Agarwal, D. A."],"key":"crystal-ornelas2021","id":"crystal-ornelas2021","bibbaseid":"crystalornelas-varadharajan-bondlamberty-boye-burrus-cholia-crow-damerow-etal-aguidetousinggithubfordevelopingandversioningdatastandardsandreportingformats-2021","role":"author","urls":{"Paper":"https://agupubs.onlinelibrary.wiley.com/doi/10.1029/2021EA001797"},"keyword":["/unread"],"metadata":{"authorlinks":{}}},"bibtype":"article","biburl":"https://api.zotero.org/groups/2386895/collections/FDNHDHM4/items?format=bibtex&limit=100","dataSources":["argdh7LKGZkauRL3j"],"keywords":["/unread"],"search_terms":["guide","using","github","developing","versioning","data","standards","reporting","formats","crystal‐ornelas","varadharajan","bond‐lamberty","boye","burrus","cholia","crow","damerow","devarakonda","ely","goldman","heinz","hendrix","kakalia","pennington","robles","rogers","simmonds","velliquette","weierbach","weisenhorn","welch","agarwal"],"title":"A Guide to Using GitHub for Developing and Versioning Data Standards and Reporting Formats","year":2021}