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 合併指標
 (30 天內沒有已合併 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