opensearch-project/demos

[FEATURE][DocBot] README revamp

オープン

#89 opened on 2023/11/06

GitHub で見るコントリビューターガイド
 (1 件のコメント) (0 件のリアクション) (0 人の担当者) (18 件のフォーク)auto 404
OSCIdocumentationenhancementgood first issue

Repository metrics

Stars
 (4 個のスター)
PR merge metrics
 (PR metrics pending)

説明

Is your feature request related to a problem?

Since starting DocBot we have made a lot of progress however our README.md file has not kept up. We need to describe what the DocBot project does succinctly and give an overview of it's parts.

What solution would you like?

Updated README.md file

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

調査方針
現在の README.md を確認し、プロジェクトの構造とコンポーネントを理解した上で、プロジェクトの説明、各部分の概要、そして場合によってはインストール/使用手順を含む更新された README をドラフトしてください。
技術スタック
なし
領域
documentation
Issue 種別
機能
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
1
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3時間
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
Git
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
90