OpenFreeEnergy / OpenFreeEnergy/openfe
cli yaml: implement auto documenter
Abierto
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Python
- Estrellas
- 331
- Forks
- 56
- Merge medio
- 3 d 9 h
- PR fusionados (30 d)
- 13
Descripción
ideally we can generate example yaml files for the CLI from the CLI, that can then be customised then used
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Comienza localizando los puntos de entrada de la CLI que analizan la configuración YAML. Determina cómo debería un comando auto-documenter generar archivos YAML de ejemplo que puedan personalizarse y luego ser aceptados por la CLI. Se considera completado cuando los ejemplos generados se pueden usar como entradas de la CLI y cubren las opciones de configuración previstas.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- python
- Área
- cli, documentation
- Tipo de issue
- Nueva funcionalidad
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 35/100