Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Improve in-code documentation

Abierto
#175 2 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
20/100
Tipo de issue
Documentación
Claridad
Necesita aclaración
Estado de actividad
Estancado
Stack tecnológico
python
Área
documentation

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.

Descripción

enhancement

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.

Lenguaje dominante
Python
Estrellas
342
Forks
65
Sin PR fusionados en 30 d

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de cloudevents/sdk-python

Todos los issues de cloudevents/sdk-python

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.