MerginMaps / MerginMaps/python-api-client
Add example to the command lines
Abierto
Nadie ha tomado este issue todavía.
enhancement
good first issue
- Lenguaje dominante
- Python
- Estrellas
- 23
- Forks
- 12
- Merge medio
- 2 d 13 h
- PR fusionados (30 d)
- 7
Descripción
I am struggling to use most of the command lines reading the help files. Like most terminal commands, I prefer to look at examples!
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
Comience revisando los archivos de ayuda de la línea de comandos e identificando qué comandos carecen de ejemplos de uso. Añada ejemplos prácticos para los comandos incluidos en la solicitud y, después, verifique que la salida de ayuda muestre claramente cómo se utiliza cada comando.
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
- Documentación
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Estado de actividad
- Estancado
- Claridad
- Necesita aclaración
- Aptitud para principiantes
- 30/100