OpenFreeEnergy / OpenFreeEnergy/openfe
cli yaml: implement auto documenter
Offen
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 332
- Forks
- 56
- Ø Merge
- 3 T. 9 Std.
- Gemergte PRs (30 T.)
- 13
Beschreibung
ideally we can generate example yaml files for the CLI from the CLI, that can then be customised then used
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne damit, die CLI-Einstiegspunkte zu finden, die YAML-Konfigurationen parsen. Ermittle, wie ein auto-documenter-Befehl Beispiel-YAML-Dateien generieren sollte, die angepasst und anschließend von der CLI akzeptiert werden können. Als erledigt gilt die Aufgabe, wenn die generierten Beispiele als CLI-Eingaben verwendbar sind und die vorgesehenen Konfigurationsoptionen abdecken.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- cli, documentation
- Issue-Typ
- Feature
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100