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

For Central API docs, show optional/required info

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

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

評価

難易度
3/5
見積もり時間
1〜2日
初心者へのやさしさ
45/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
停滞
領域
documentation

調査の方向性

リンクされた行の周辺にある docs/api.yaml から始め、Central API スキーマが Sphinx ドキュメントでどのようにレンダリングされるかを調査してください。任意および必須の情報がどこで失われているかを確認し、その後、レンダリングされた API ドキュメントに例のエンドポイントについてその情報が明示的に表示されることを検証してください。

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

説明

Central

For example: https://github.com/getodk/central-backend/blob/0cd56948854ecc544a1b4af9efd88cf9ceee153d/docs/api.yaml#L11958 -- this is not surfaced in the rendered docs.

主要言語
Python
スター
58
フォーク
160
平均マージ
4日 21時間
マージ済み PR（30日）
6

環境構築

はじめの一歩

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

getodk/docs のほかの issue

getodk/docs の issue をすべて見る

似ている issue

Python の issue をもっと見る

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

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