codrsquad / codrsquad/portable-python
Request: More detailed documentation about the configuration file
オープン
まだ誰も着手していません。
- 主要言語
- Python
- スター
- 86
- フォーク
- 13
- PR マージ指標
- 30日以内にマージされた PR はありません
説明
This repository has a very high code quality and very decent output.
I notice this portable-python package is quite configurable, but I can't find any documentation about it, and have to read the source code and test cases. It is not very efficient and a little painful.
Is that possible to add more documentation about portable-python.yaml?
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず、portable-python.yaml を定義しているソースコードとテストケースを確認し、利用可能な設定オプションとその使用方法を文書化します。ユーザーがソースコードやテストを調べなくてもパッケージを理解して設定できるようになれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- python
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 2/5
- 見積もり時間
- 1〜2日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 45/100