nteract/testbook

Add more explicit steps to the Getting Started example

Open

#114 opened on May 20, 2021

View on GitHubContributor guide
 (2 comments) (1 reaction) (0 assignees)Python (38 forks)auto 404
documentationgood first issuesprint-friendly

Repository metrics

Stars
 (435 stars)
PR merge metrics
 (PR metrics pending)

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.

Contributor guide

Research direction
Review the current Getting Started documentation. Identify where to add explicit steps for creating the notebook file (.ipynb) and the test file (.py). Add a step showing how to run the test file.
Tech stack
python
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90