Add better docs for new options system
まだ誰も着手していません。
評価
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 初心者へのやさしさ
- 45/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- ruby
- 領域
- cli, documentation
調査の方向性
lib/cli/kit/opts.rb から始めて、option、multi_option、position、rest、skippable positions、callable defaults を理解します。--no-<multi_option> パターンについては pull request #246 を読んでください。列挙された動作を含め、新しいオプションシステムと有用なパターンが文書化されていれば完了です。
索引モデルが issue の本文から書いたものです。
説明
We don't have much in the way of docs covering the new option system. There are many things in https://github.com/Shopify/cli-kit/blob/main/lib/cli/kit/opts.rb that should probably be covered, e.g.
- option
- multi_option
- position
- rest
- skippable positions
- callable defaults
- ...
Additionally, it would be good to include useful patterns such the --no-<multi_option> flag to zero a multi_option default described in https://github.com/Shopify/cli-kit/pull/246
- 主要言語
- Ruby
- スター
- 161
- フォーク
- 16
- 平均マージ
- 3時間 21分
- マージ済み PR（30日）
- 5
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
Shopify/cli-kit のほかの issue
Shopify/cli-kit の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
palladius/rails8-app-on-gcp#145 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
rubocop/rubocop-rspec#2236 ·
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
riscv/riscv-unified-db#2624 · リアクション 1 件 ·
-
難易度 1/5 1時間未満 初心者へのやさしさ 88/100