Documentation
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Aptitud para principiantes
- 25/100
- Tipo de issue
- Documentación
- Claridad
- Necesita aclaración
- Estado de actividad
- Estancado
- Stack tecnológico
- github-actions, python
- Área
- ci-cd, documentation
Línea de trabajo
Comienza inventariando los proyectos, componentes y funciones y clases importantes de libs, y después revisa los archivos README y los workflows existentes del repositorio. Define el alcance de la documentación, las instrucciones de instalación y ejecución, la configuración de Sphinx y los pasos para publicar en GitHub Pages antes de implementarlos. Se considera terminado cuando todos los proyectos y componentes solicitados tienen descripciones generales e instrucciones, las APIs importantes de libs tienen docstrings y la documentación generada se publica mediante el workflow.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Create READMEs for all projects and components, including installation and running instructions as well as overviews of functionality.
Create docstrings for all functions and classes of importance in libs and use Sphinx+GitHub workflows to automatically generate documentation which gets pushed to a GitHub page.
- Lenguaje dominante
- Python
- Estrellas
- 11
- Forks
- 6
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Sin plantilla de pull request
- Leer la 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.
Más de ML4GW/DeepClean
-
Dificultad 5/5 Más de una semana Aptitud para principiantes 15/100
-
question research topic
Dificultad 5/5 Más de una semana Aptitud para principiantes 20/100
-
enhancement
Dificultad 3/5 1-2 días Aptitud para principiantes 45/100
-
bug documentation good first issue
Dificultad 2/5 1-3 horas Aptitud para principiantes 45/100
-
Dificultad 3/5 1-2 días Aptitud para principiantes 35/100
Todos los issues de ML4GW/DeepClean
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 90/100
SublimeText/AdvancedNewFile#211 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 73/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 83/100
Imbad0202/academic-research-skills#987 ·
Los mantenedores suelen responder en 1 día
-
Add date of request to the UIAbierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 62/100
-
Pull-through from gcr.io returns 500 when pulling using podman/buildahPosiblemente ocupada Un pull request vinculado a esta issue está abierto o ya se fusionó. AbiertoIssue Triage-Needed
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
pulp/pulp_container#2581 ·
Los mantenedores suelen responder en 1 día