kernelci / kernelci/kernelci-api

Developers documentation

未关闭
#369 3 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
critical
主要语言
Python
星标
10
派生
21
PR 合并指标
30 天内没有已合并 PR

描述

The current [documentation](https://kernelci.org/docs/api/) 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.

贡献指南

这个仓库没有索引到贡献指南

调研方向

Start with the current API documentation at https://kernelci.org/docs/api/ and compare it with the API code to identify established areas suitable for contributor documentation. Document the stable API internals, models, developer howtos, and configuration; completion means contributors can understand and work with those areas without relying only on the code.

由索引模型根据 Issue 内容生成。

评估

技术栈
python
领域
api, backend, documentation
Issue 类型
文档
难度
5/5
预计耗时
一周以上
活跃度
停滞
描述清晰度
需要澄清
新手友好度
25/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。