Developers documentation
還沒有人認領這個 Issue。
評估
- 難度
- 5/5
- 預估耗時
- 一週以上
- 新手友好度
- 25/100
- Issue 類型
- 文件
- 描述清晰度
- 需要釐清
- 活躍度
- 停滯
- 技術堆疊
- python
- 領域
- api, backend, documentation
研究方向
從 https://kernelci.org/docs/api/ 上的目前 API 文件開始，並將其與 API 程式碼進行比較，以找出適合撰寫貢獻者文件的既有領域。記錄穩定的 API 內部實作、模型、開發者操作指南和設定；當貢獻者不必只依賴程式碼就能理解並使用這些領域時，即表示完成。
由索引模型根據 Issue 內容生成。
描述
The current documentation is still fairly incomplete and high-level. It conveys the purpose of the new API and pipeline and it presents basic usage for the simplest use cases, which is a good way to start getting the attention of potential users, but at this point it still doesn't contain any relevant information for contributors: API internals, models, howtos for developers, configuration, etc.
This suggests that parts of the design are still in flux and not fully stabilized.
Any person that wants to contribute needs to read and understand the code, which also lacks proper documentation in most places. This is risky because a contributor might draw certain design conclusions from the code that may not be right or that could be provisional.
Adding a stable documentation for the API parts that are well established should be a priority to encourage external contributions.
- 主要語言
- Python
- 星號
- 10
- 分支
- 21
- 平均合併
- 22 分鐘
- 30 天內合併 PR
- 1
環境準備
- 提供 Dockerfile 或 Docker Compose 檔案
- 沒有 Pull Request 範本
- 沒有貢獻指南
從這裡開始
- 先讀完整個 Issue，再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫，在一個分支上完成修改。
- 送出 Pull Request，並在描述裡引用這個 Issue 編號。
kernelci/kernelci-api 的其他 Issue
-
難度 4/5 3-5 天 新手友好度 45/100
kernelci/kernelci-api#706 ·
-
Components/Maestro/API/Local instance says GET /latest/ should return some JSON, but it doesn't可能重新可做 關聯的 PR 已關閉且未合併。 未關閉documentation
難度 3/5 1-2 天 新手友好度 35/100
kernelci/kernelci-api#632 · 1 則留言 ·
-
難度 5/5 一週以上 新手友好度 20/100
kernelci/kernelci-api#629 ·
-
難度 4/5 3-5 天 新手友好度 35/100
kernelci/kernelci-api#608 ·
-
難度 3/5 1-2 天 新手友好度 35/100
kernelci/kernelci-api#597 · 2 則留言 ·
查看 kernelci/kernelci-api 的全部 Issue
相似的 Issue
-
Maven path-index: "Ambiguous or noncanonical artifact path" error does not report the offending path未關閉
難度 2/5 1-3 小時 新手友好度 76/100
pulp/pulp_maven#524 ·
維護者通常 1 天內回覆
-
難度 1/5 1-3 小時 新手友好度 82/100
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 76/100
維護者通常 3 天內回覆
-
難度 1/5 1-3 小時 新手友好度 88/100
infinispan/langchain-infinispan#34 ·
維護者通常 1 天內回覆
-
難度 1/5 1 小時以內 新手友好度 85/100
521xueweihan/HelloGitHub#3891 ·