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
-
bug
难度 2/5 1-3 小时 新手友好度 72/100
awslabs/visual-asset-management-system#414 ·
维护者通常 1 天内回复
-
bug v1 v2
难度 2/5 1-3 小时 新手友好度 75/100
modelcontextprotocol/python-sdk#3670 · 1 条评论 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 82/100
aicell-lab/bioengine#232 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 74/100
modelscope/evalscope#1836 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 72/100