testbook icon indicating copy to clipboard operation
testbook copied to clipboard

Add more explicit steps to the Getting Started example

Open willingc opened this issue 4 years ago โ€ข 2 comments

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.

willingc avatar May 20 '21 10:05 willingc

Hello! I'm new to contributing and looking for something to work on. It looks like there hasn't been any progress as there isn't a Getting Started section.

mmoralls avatar May 20 '21 16:05 mmoralls

Hello @mmoralls, the initial work on the project was mostly through Google Summer of Code, but it's had attention and improvements since then. We're outlining a range of issues for new contributors, especially with the PyLadies mentored sprint coming up this weekend. Tickets like this are to lower friction points for new contributors but it's certainly not a blocker to work on the project!

MSeal avatar May 20 '21 19:05 MSeal