Add comments and type hints to Python code

オープン
#415 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
35/100
issue の種類
リファクタリング
明瞭さ
説明が足りない
活発さ
停滞
技術スタック
python

調査の方向性

この issue では、ファイル、テスト、エントリーポイントのいずれも指定されていません。まず Python コードを一覧化し、どのモジュールを対象範囲に含めるかを定義してから、コメントと型ヒントを一貫して追加してください。合意した対象範囲が文書化され、更新後のコードが引き続き機能すれば完了です。

索引モデルが issue の本文から書いたものです。

説明

enhancement

The python code current has nearly zero comments, which makes it difficult for people to figure out what the code is actually doing. Having comments would make it easier for people who are less familar with python and this specific codebase to contribute. Type hints would also be a useful addition for similar reasons.

主要言語
Python
スター
12
フォーク
40
平均マージ
1日 13時間
マージ済み PR(30日)
1

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

ComputerScienceHouse/conditional のほかの issue

ComputerScienceHouse/conditional の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。