immjunjie/SSJOD

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

Aperta

#33 aperta il 21 mag 2025

Vedi su GitHub
 (0 commenti) (0 reazioni) (5 assegnatari)G-code (0 fork)auto 404
documentationhelp wantedquestion

Metriche repository

Star
 (1 stella)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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

Guida contributor

Direzione di ricerca
Migliora il wiki del progetto aggiungendo sottotitoli e spiegazioni per HDF5, dati raccolti, dataset e Zenodo basati sui feedback.
Tech stack
Nessuno
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80