InsightSoftwareConsortium / InsightSoftwareConsortium/SimpleITK-Notebooks

Writing a notebook contribution guide

Offen
#328 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
Vorherrschende Sprache
Jupyter Notebook
Sterne
906
Forks
374
Ø Merge
54 Min.
Gemergte PRs (30 T.)
1

Beschreibung

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`

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Start by reviewing issue #321 and the notebook contribution needs described there, then inspect the notebooks under Python/*.ipynb. The guide should be added to the SimpleITK Notebooks documentation at readthedocs.io and explain Black formatting plus the nbstripout command with empty-cell stripping; it is done when these cleanup steps are documented for contributors.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
jupyter-notebook, python
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.