immjunjie/SSJOD

docs(wiki): improve the project wiki from the feedbacks

开放

#33 创建于 2025年5月21日

在 GitHub 查看
 (0 条评论) (0 个反应) (5 位负责人)G-code (0 个派生)auto 404
documentationhelp wantedquestion

仓库指标

星标
 (1 个星标)
PR 合并指标
 (PR 指标待抓取)

描述

Actions

  • Read the feedbacks from Cathal
  • Add subheadings into developer documentation [e.g. hdf5, what kind of data is collected, more details of how to start the development]

Tasks

  • Improve the GitHub Wiki from the feedbacks
    • HDF5
      • What is this?
      • Why this is needed?
      • How would we can use this?
    • Collected Data
      • What are these?
      • Why these are needed?
      • How these could be collected?
    • DataSets
      • What are these?
      • Why these are needed?
      • How these could be stored and used?
    • Zenodo
      • What is this?
      • Why this is needed?
      • How would we can use this?
    • ...not...sure...yet
  • Add more from my notepad later

Redirection

Res & Ref

贡献者指南

研究方向
根据反馈，通过为HDF5、收集的数据、数据集和Zenodo添加副标题和解释来改进项目wiki。
技术栈
无
领域
documentation
议题类型
文档
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
1
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 小时
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
Git
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
80