linkedin / linkedin/python-avro-json-serializer
Better doc
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Python
- Estrellas
- 135
- Forks
- 43
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Descripción
Hi,
I'm a user of your library, it's great.
I had a couple of suggestion to improve the doc:
* add how to install w/ pip
* add imports statement to the examples
* add deserialize example
I can actually do it if you want.
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
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
Empieza por localizar la documentación y los ejemplos actuales del proyecto y, después, revisa cómo se describen actualmente la instalación y la serialización. Actualiza la documentación para incluir la instalación con pip, imports en los ejemplos y un ejemplo de deserialize; se considera terminado cuando las tres solicitudes están cubiertas y los ejemplos siguen siendo comprensibles.
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
- Medio día
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 45/100