Bash-it/bash-it

Add documentation for all commands

Open

#1,680 opened on 2020年10月15日

GitHub で見る
 (9 comments) (0 reactions) (0 assignees)Shell (2,304 forks)batch import
documentationhelp wanted

Repository metrics

Stars
 (15,045 stars)
PR merge metrics
 (平均マージ 4d 17h) (30d で 2 merged PRs)

説明

I'm wondering whether we want to include this in the documentation. I've checked the main README file, it currently does not provide a complete list of all commands (e.g. bash-it reload). We might want to add that at one point - probably as a separate PR when (hopefully at one point) rework the documentation.

Originally posted by @nwinkler in https://github.com/Bash-it/bash-it/pull/1672#issuecomment-709528853

コントリビューターガイド

調査方針
現在の README.md とリポジトリ内のドキュメントファイルを調べて、どのコマンドが既に文書化されているかを特定します。コマンド定義ファイル（例：plugins、aliases、lib 内）をチェックして、利用可能なすべてのコマンドをリストアップします。この問題は特に 'bash it reload' が欠けていると指摘しています。包括的なリストを作成し、ドキュメントに追加することを目指します。
技術スタック
shell
領域
documentation
Issue 種別
ドキュメント
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
半日
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
古い
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
Knowledge of Bash it commandsFamiliarity with MarkdownAccess to Bash it source code
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
70