InsightSoftwareConsortium / InsightSoftwareConsortium/SimpleITK-Notebooks
Writing a notebook contribution guide
- Lenguaje dominante
- Jupyter Notebook
- Estrellas
- 906
- Forks
- 374
- Merge medio
- 54 min
- PR fusionados (30 d)
- 1
Descripción
As discussed in #321, it is desired to keep the jupyter notebooks clean for version control.
Therefore, a contribution Guide for the notebooks could be written.
This guide could also be in form of a notebook and live at https://simpleitk-notebooks.readthedocs.io/.
Things that come into my mind for notebooks right now:
* They should get formatted by the `black` formatter.
* Metadata and empty cells should be cleaned by `nbstripout Python/*.ipynb --strip-empty-cells`
Guía de contribución
Línea de trabajo
Comienza revisando el issue #321 y las necesidades de contribución de notebooks descritas allí; después, inspecciona los notebooks de Python/*.ipynb. La guía debe añadirse a la documentación de SimpleITK Notebooks en readthedocs.io y explicar el formateo con Black, además del comando nbstripout para eliminar celdas vacías; estará terminada cuando estos pasos de limpieza estén documentados para las personas colaboradoras.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- jupyter-notebook, python
- Área
- documentation
- Tipo de issue
- Documentación
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 35/100