immjunjie/SSJOD

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

Offen

#33 geöffnet am 21.05.2025

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (5 zugewiesene Personen)G-code (0 Forks)auto 404
documentationhelp wantedquestion

Repository-Metriken

Stars
 (1 Stern)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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-Richtung
Verbessern Sie das Projekt Wiki, indem Sie auf der Grundlage des Feedbacks Unterüberschriften und Erläuterungen für HDF5, gesammelte Daten, Datensätze und Zenodo hinzufügen.
Tech Stack
Keine
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80