OpenFreeEnergy / OpenFreeEnergy/openfe
cli yaml: implement auto documenter
Aperta
Nessuno ha ancora preso questa issue.
- Lingua principale
- Python
- Stelle
- 332
- Fork
- 56
- Merge medio
- 3g 9h
- PR unite (30g)
- 13
Descrizione
ideally we can generate example yaml files for the CLI from the CLI, that can then be customised then used
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia individuando i punti di ingresso della CLI che analizzano la configurazione YAML. Determina come un comando auto-documenter dovrebbe generare file YAML di esempio che possano essere personalizzati e poi accettati dalla CLI. Il lavoro è completato quando gli esempi generati sono utilizzabili come input della CLI e coprono le opzioni di configurazione previste.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- python
- Ambito
- cli, documentation
- Tipo di issue
- Funzionalità
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100