Hacktoberfest 2026：メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

(auto)generate up-to-date documentation

オープン
  • 何か問題がありますか？
#2,398 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
25/100
issue の種類
ドキュメント
明瞭さ
説明が足りない
活発さ
停滞
技術スタック
fastapi, python
領域
api, backend, documentation

調査の方向性

まず、リンクされた staging /docs エンドポイントにある既存の FastAPI ドキュメントと、概念実証で示されている kernelci.api.models モジュールを確認します。現在、kci コマンド、API エンドポイント、Node サブクラスがどのように表現されているかを比較し、そのうえで、生成されるドキュメントで 3 つすべての領域をカバーする必要があるものを定義します。合意したドキュメントが生成され、ユーザーと開発者の両方が利用できれば完了です。

索引モデルが issue の本文から書いたものです。

説明

documentation techdebt

As mentioned in other issues (such as #2040 and #2092), the new system lacks documentation for both users and developers.

A first step in solving this problem could be to look at auto-generation for items easily documented in the code itself. this includes:

  • kci commands
  • API endpoints
    • fastapi already provides some kind of endpoint/schema documentation, but it's incomplete and barely usable; we could, however, have a look at how this works and get some inspiration there
  • Node types & formats
    • Partly provided by fastapi (see above) but only documents the top-level Node model, not any of its sub-classes
    • We could create a script which would leverage pydantic's schema() creation facilities, see the following PoC for an example:
import kernelci, inspect
from kernelci.api.models import *

def iskcimodel(model):
    if (inspect.isclass(model) and
        model.__module__ == "kernelci.api.models" and
        hasattr(model, 'schema')):
        return True
    return False

for name, myclass in inspect.getmembers(kernelci.api.models, iskcimodel):
    print(f"{name} -> {myclass.schema()}")
主要言語
Python
スター
119
フォーク
109
平均マージ
7時間 30分
マージ済み PR（30日）
14

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

kernelci/kernelci-core のほかの issue

kernelci/kernelci-core の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。