MattIPv4 / MattIPv4/PyDMXControl
[Python] Implement docstrings and testing
オープン
まだ誰も着手していません。
good first issue
hacktoberfest
help wanted
🆕 Enhancement
- 主要言語
- Python
- スター
- 143
- フォーク
- 23
- PR マージ指標
- 30日以内にマージされた PR はありません
説明
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.
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
この issue では、ファイル、テスト、エントリーポイントが指定されていません。まず Python ライブラリを調査して、docstring と回帰テストの範囲を定義します。完了には、コードがドキュメント化され、既存のメソッドを保護する有意義なテストがあることが必要です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- python
- 領域
- documentation, testing
- issue の種類
- ドキュメント
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 活発さ
- 停滞
- 明瞭さ
- 説明が足りない
- 初心者へのやさしさ
- 20/100