immjunjie/SSJOD

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

Open

#33 opened on May 21, 2025

View on GitHub
 (0 comments) (0 reactions) (5 assignees)G-code (0 forks)auto 404
documentationhelp wantedquestion

Repository metrics

Stars
 (1 star)
PR merge metrics
 (PR metrics pending)

Description

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

Contributor guide

Research direction
Improve the project wiki by adding subheadings and explanations for HDF5, collected data, datasets, and Zenodo based on feedback.
Tech stack
None
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80