five

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

收藏
Mendeley Data2024-03-27 更新2024-06-28 收录
下载链接:
https://www.osti.gov/servlets/purl/1780564/
下载链接
链接失效反馈
官方服务:
资源简介:
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.

本数据包包含三款基于Markdown语言编写的模板,可用于创建适配社区主导的数据报告格式的README文件与议题模板(Issue Templates)。本模板集基于一项系统综述的研究成果(详见相关参考文献)编写而成,该综述探讨了数据标准文档开发团队如何借助版本控制平台GitHub协作编制支撑文档。我们通过对32个GitHub代码仓库的调研,针对README文件的内容给出了针对性建议(例如提供用户许可协议、说明用户贡献方式),因此`README_template.md`包含各章节的标题框架。本次数据包收录的两款议题模板——`issue_template_for_all_other_changes.md`与`issue_template_for_documentation_change.md`——可在GitHub代码仓库中用于规范用户提交的议题,也可根据数据标准开发者的实际需求进行自定义修改。我们在GitHub上搭建ESS-DIVE社区空间(https://github.com/ess-dive-community)时便采用了上述模板,该空间包含社区主导的数据报告格式相关文档。此外,本数据包还附带文件级元数据文件`flmd.csv`,用于详细描述数据包内各文件的具体内容。最后,我们在元数据中标注的时间范围,即为我们在GitHub平台上检索已文档化数据标准的周期。
创建时间:
2023-06-28
5,000+
优质数据集
54 个
任务类型
进入经典数据集
二维码
社区交流群

面向社区/商业的数据集话题

二维码
科研交流群

面向高校/科研机构的开源数据集话题

数据驱动未来

携手共赢发展

商业合作