MerginMaps / MerginMaps/python-api-client

Add example to the command lines

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

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

enhancement good first issue
主要言語
Python
スター
23
フォーク
12
平均マージ
2日 13時間
マージ済み PR(30日)
7

説明

I am struggling to use most of the command lines reading the help files. Like most terminal commands, I prefer to look at examples!

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

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

はじめの一歩

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

調査の方向性

まずコマンドラインのヘルプファイルを確認し、使用例がないコマンドを特定します。依頼の対象となるコマンドに実用的な例を追加し、その後、ヘルプ出力に各コマンドの使用方法が明確に示されていることを確認します。

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

評価

技術スタック
python
領域
cli, documentation
issue の種類
ドキュメント
難易度
3/5
見積もり時間
1〜2日
活発さ
停滞
明瞭さ
説明が足りない
初心者へのやさしさ
30/100

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

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