nteract/testbook

Add more explicit steps to the Getting Started example

オープン

#114 opened on 2021/05/20

GitHub で見るコントリビューターガイド
 (2 件のコメント) (1 件のリアクション) (0 人の担当者)Python (38 件のフォーク)auto 404
documentationgood first issuesprint-friendly

Repository metrics

Stars
 (435 個のスター)
PR merge metrics
 (PR metrics pending)

説明

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
Issue 種別
ドキュメント
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
1
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1時間未満
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
なし
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
90