nteract/testbook

Add more explicit steps to the Getting Started example

Offen

#114 geöffnet am 20.05.2021

Auf GitHub ansehenContributor Guide
 (2 Kommentare) (1 Reaktion) (0 zugewiesene Personen)Python (38 Forks)auto 404
documentationgood first issuesprint-friendly

Repository-Metriken

Stars
 (435 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

Improve the Getting Started section of the docs.

Right now it's easy to miss that two files are needed: a notebook (.ipynb file) to test and a test file (.py file) to write the tests.

It would also be helpful to add an explicit step on how to run the test file.

Contributor Guide

Research-Richtung
Ueberpruefen Sie die aktuelle 'Getting Started' Dokumentation. Identifizieren Sie, wo explizite Schritte zum Erstellen der Notebook Datei (.ipynb) und der Testdatei (.py) hinzugefuegt werden sollen. Fuegen Sie einen Schritt hinzu, der zeigt, wie die Testdatei ausgefuehrt wird.
Tech Stack
python
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Keine
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
90