Developers documentation
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 25/100
- issue の種類
- ドキュメント
- 明瞭さ
- 説明が足りない
- 活発さ
- 停滞
- 技術スタック
- python
- 領域
- api, backend, documentation
調査の方向性
https://kernelci.org/docs/api/ にある現在の API ドキュメントから始め、API コードと比較して、コントリビューター向けドキュメントに適した確立された領域を特定します。安定した API 内部、モデル、開発者向け How-to、設定をドキュメント化します。コントリビューターがコードだけに頼らずにそれらの領域を理解し、扱えるようになれば完了です。
索引モデルが 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分
- マージ済み PR（30日）
- 1
環境構築
- Dockerfile または Docker Compose ファイルあり
- プルリクエストのテンプレートなし
- コントリビューションガイドなし
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- 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再び着手できるかも このイシューのプルリクエストはマージされずにクローズされました。 オープンdocumentation
難易度 3/5 1〜2日 初心者へのやさしさ 35/100
kernelci/kernelci-api#632 · コメント 1 件 ·
-
難易度 5/5 1週間以上 初心者へのやさしさ 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
-
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
rpm-software-management/mock#1824 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
jpata/particleflow#520 ·
メンテナーはふだん 1 日以内に返信
-
bug good first issue hacktoberfest
難易度 1/5 1時間未満 初心者へのやさしさ 78/100
gridhead/gi-loadouts#699 ·
メンテナーはふだん 13 日以内に返信
-
難易度 1/5 1時間未満 初心者へのやさしさ 86/100
FinanceFlash/unvibecode#206 ·
メンテナーはふだん 1 日以内に返信