opensearch-project/demos

[FEATURE][DocBot] README revamp

開放

#89 建立於 2023年11月6日

在 GitHub 查看貢獻者指南
 (1 則留言) (0 個反應) (0 位負責人) (18 個分叉)auto 404
OSCIdocumentationenhancementgood first issue

倉庫指標

星標
 (4 顆星)
PR 合併指標
 (PR 指標待抓取)

描述

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
議題類型
功能
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
1
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 小時
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
活躍
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
清晰
前置要求
Git
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
90