cloudevents / cloudevents/sdk-python
Improve in-code documentation
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Python
- Estrellas
- 342
- Forks
- 65
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Descripción
Almost all code now lacks proper pydocs across almost all the codebase. We should consider the following PRs are gonna improve the situation.
It should be prohibited to merge PRs that do not have docs. We should eventually cover all the missing places with appropriate documentation and 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
Comienza examinando la base de código de Python en busca de pydocs faltantes y revisando los PRs propuestos mencionados en la issue. El alcance abarca la documentación y los ejemplos de casi todo el código, además de una política para prevenir PRs sin documentación. Para darlo por terminado sería necesario contar con un enfoque acordado y una cobertura amplia de la documentación que falta.
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
- 5/5
- Tiempo estimado
- Más de una semana
- Estado de actividad
- Estancado
- Claridad
- Necesita aclaración
- Aptitud para principiantes
- 20/100