falconry/falcon

Type Hints: Add type hints to tutorials, snippets and examples

Open

#1,820 opened on 2020年12月17日

GitHub で見る
 (17 comments) (0 reactions) (0 assignees)Python (925 forks)batch import
documentationenhancementgood first issueneeds contributor

Repository metrics

Stars
 (9,293 stars)
PR merge metrics
 (平均マージ 2d 7h) (30d で 9 merged PRs)

説明

To improve code readability and be friendlier to PEP 484, we should start adding type annotations to our code, probably starting from snippets, tutorials and examples.

Originally discussed here https://github.com/falconry/falcon/pull/1737#issuecomment-744064360

コントリビューターガイド

調査方針
リポジトリ内のチュートリアルとサンプルファイルを確認し、PEP 484の規則に従って関数シグネチャと変数宣言に型アノテーションを追加します。リンクされたプルリクエストのディスカッションにリストされているファイルから始めてください。
技術スタック
python
領域
documentation
Issue 種別
ドキュメント
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3時間
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
PythonType hints
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
80