DOC: update contributing guide to reflect the preferred practice
Abierto
Nadie ha tomado este issue todavía.
documentation
infrastructure
- Lenguaje dominante
- Sin datos de lenguaje
- Estrellas
- 673
- Forks
- 229
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Descripción
Currently missing points:
- No outputs should be included in the notebooks
- we do prefer
.mdfiles as opposed to.ipynb.
Maybe the updated guide should be in a separate file, and keep the absolute newcomer version, that we currently have, in the README?
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
Lee la guía de contribución actual y el README para ver dónde están documentadas las prácticas relacionadas con los notebooks. Actualiza las indicaciones para establecer que los notebooks no deben contener salidas y que se prefieren los archivos .md frente a .ipynb; se considerará completado cuando la estructura de la guía elegida refleje claramente ambos puntos.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Á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
- 35/100