nteract/testbook

Add more explicit steps to the Getting Started example

开放

#114 创建于 2021年5月20日

在 GitHub 查看贡献者指南
 (2 条评论) (1 个反应) (0 位负责人)Python (38 个派生)auto 404
documentationgood first issuesprint-friendly

仓库指标

星标
 (435 个星标)
PR 合并指标
 (PR 指标待抓取)

描述

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.

贡献者指南

研究方向
查看当前的入门文档。确定在何处添加创建笔记本文件（.ipynb）和测试文件（.py）的明确步骤。添加一个显示如何运行测试文件的步骤。
技术栈
python
领域
documentation
议题类型
文档
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
1
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1 小时以内
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
无
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
90