Making `biome help` follow a better format
- 主要言語
- Shell
- スター
- 52
- フォーク
- 9
- PR マージ指標
- 30日以内にマージされた PR はありません
説明
Unix tools typically have a nice help screen. Biome's is lacking. I'm looking for some help making Biome's help page (`biome help`) a lot more informative and easy to scan.
The two workflows that are most common with Biome:
- Running `biome init` to create a new environment, then `biome use` to start using that environment inside of a new project (similar to `npm init`)
- Running `biome` to set up a freshly-cloned project (similar to an `npm install`)
Willing to work on this? Here's what you'll ideally do:
- Within the source of Biome, run: `./biome.sh help`
- Improve the help text inside of the bash script (look for `help)` in the large case statement)
- I've totally neglected to talk about Biome's ability to specify an optional environment name for any command. For example, `biome use` can take another arg and become `biome use myfancyenvironment` (that command would now apply to `myfancyenvironment` and not the environment specified in the Biomefile). This should be documented somewhere.
- Make the above workflows blatantly obvious.
Thanks!
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
調査の方向性
ヘルプテキストは bash スクリプト内の大きな case 文の中にあります(おそらく biome.sh)。現在の出力を確認するには `./biome.sh help` を実行してください。ヘルプテキストを編集するには `help)` の case を探してください。`biome use` のようなコマンドで使う任意の環境名引数を文書化してください。2 つの一般的なワークフロー(init/use と、clone したプロジェクトのセットアップ)がヘルプ出力で明確になるようにしてください。変更を検証するために、スクリプトを再度実行してテストしてください。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- bash
- 領域
- cli, documentation
- issue の種類
- ドキュメント
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 活発さ
- 停滞
- 明瞭さ
- 明確に書かれている
- 初心者へのやさしさ
- 70/100