nteract/testbook

Add more explicit steps to the Getting Started example

Aperta

#114 aperta il 20 mag 2021

Vedi su GitHubGuida contributor
 (2 commenti) (1 reazione) (0 assegnatari)Python (38 fork)auto 404
documentationgood first issuesprint-friendly

Metriche repository

Star
 (435 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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.

Guida contributor

Direzione di ricerca
Rivedi la documentazione di 'Getting Started' attuale. Identifica dove aggiungere passaggi espliciti per creare il file notebook (.ipynb) e il file di test (.py). Aggiungi un passaggio che mostri come eseguire il file di test.
Tech stack
python
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Nessuno
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
90