line / line/centraldogma-python
Add simple examples to README.md
Abierto
Nadie ha tomado este issue todavía.
documentation
- Lenguaje dominante
- Python
- Estrellas
- 21
- Forks
- 11
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Descripción
README.md could be a gentle guide for users to start centraldogma-python for the first time.
Examples:
https://github.com/line/centraldogma-go
https://github.com/line/centraldogma-rs
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 con README.md y compara el material de introducción en los repositorios vinculados centraldogma-go y centraldogma-rs. Añade ejemplos sencillos de primer uso para el cliente de Python, con suficiente contexto para que un usuario nuevo pueda seguirlos; el README debe guiar claramente por el flujo de configuración y uso inicial.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- python
- Área
- documentation
- Tipo de issue
- Documentación
- Dificultad
- 2/5
- Tiempo estimado
- 1-3 horas
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 45/100