[Python] Implement docstrings and testing
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 20/100
- issue の種類
- ドキュメント
- 明瞭さ
- 説明が足りない
- 活発さ
- 停滞
- 技術スタック
- python
- 領域
- documentation, testing
調査の方向性
この issue では、ファイル、テスト、エントリーポイントが指定されていません。まず Python ライブラリを調査して、docstring と回帰テストの範囲を定義します。完了には、コードがドキュメント化され、既存のメソッドを保護する有意義なテストがあることが必要です。
索引モデルが issue の本文から書いたものです。
説明
Currently the library has a lot of code dumped throughout that has no documentation associated to explain what it does. Additionally, there is no real testing in place to ensure older methods are not broken by never changes etc.
Therefor, implementing correct docstrings throughout the code and implementing proper testing would be a good way to bring up the quality of the library.
- 主要言語
- Python
- スター
- 143
- フォーク
- 23
- PR マージ指標
- 30日以内にマージされた PR はありません
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
MattIPv4/PyDMXControl のほかの issue
-
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
MattIPv4/PyDMXControl#60 · コメント 2 件 ·
-
難易度 4/5 3〜5日 初心者へのやさしさ 30/100
MattIPv4/PyDMXControl#58 ·
-
難易度 5/5 1週間以上 初心者へのやさしさ 25/100
MattIPv4/PyDMXControl#56 · コメント 2 件 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 35/100
MattIPv4/PyDMXControl#55 · コメント 3 件 ·
-
難易度 5/5 1週間以上 初心者へのやさしさ 18/100
MattIPv4/PyDMXControl#52 · コメント 5 件 ·
MattIPv4/PyDMXControl の issue をすべて見る
似ている issue
-
agent-ready documentation needs-triage
難易度 1/5 1〜3時間 初心者へのやさしさ 88/100
-
documentation
難易度 1/5 1時間未満 初心者へのやさしさ 91/100
-
workflow-status page template still says reusable workflows are "triggered only by workflow_call:" オープン
難易度 1/5 1時間未満 初心者へのやさしさ 92/100
-
instance instance add
難易度 1/5 1時間未満 初心者へのやさしさ 72/100
searxng/searx-instances#939 · コメント 1 件 ·
-
area-deployment area-integrations triage:bot-seen
難易度 2/5 半日 初心者へのやさしさ 86/100