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 合併指標
 (30 天內沒有已合併 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