nteract/testbook

Add more explicit steps to the Getting Started example

Ouverte

#114 ouverte le 20 mai 2021

Voir sur GitHubGuide contributeur
 (2 commentaires) (1 réaction) (0 personne assignée)Python (38 forks)auto 404
documentationgood first issuesprint-friendly

Métriques du dépôt

Stars
 (435 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

Description

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.

Guide contributeur

Direction de recherche
Examinez la documentation actuelle de 'Getting Started'. Identifiez ou ajouter des etapes explicites pour creer le fichier notebook (.ipynb) et le fichier de test (.py). Ajoutez une etape montrant comment executer le fichier de test.
Stack technique
python
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Aucun
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90