next-exp/IC

Standardize naming of groups and nodes in output files

Open

#819 geöffnet am 25. Mai 2022

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Python (77 Forks)auto 404
good first issue

Repository-Metriken

Stars
 (10 Stars)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

So far, we have named the groups and nodes of our output files slightly randomly. I propose that we name them in a standard manner. We can discuss other options, but my preferred one is /data_type/node_name, where

  • data_type can be RWF, PMAPS, KDST, HDST, DDST, etc, and
  • node_name will be something descriptive of what it holds (like S1Pmt for pmaps) or simply data for when there is a single table, and there is no obvious better name for the node.

Of course, this will need to update some of our reader functions so they are backward-compatible, but it might be worth the effort. Thoughts?

Contributor Guide

Research-Richtung
Besprechen Sie Namenskonventionen und implementieren Sie abwärtskompatible Änderungen in den Lesefunktionen.
Tech Stack
python
Domain
data
Issue Type
Refactoring
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
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.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Basic knowledge of the project's data types
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70