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

API Documentation Detail

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

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

評価

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

調査の方向性

まず、要求されているドキュメント領域を一覧化します。データベースのマイグレーションとダンプ、db の命名規則、buildQuery、wrangler.toml と scraper スクリプト、REST および GraphQL エンドポイント、テストです。執筆する前に、既存の docs サイトと docs ページの場所を確認します。完了の条件は、ドキュメント化されたワークフローがデータベースの変更からエンドポイントのテストまでをカバーし、エラーコード、例、変更されたファイル、注意すべき領域を含んでいることです。

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

説明

DB Design / Changes:

  • db migrations + process of implementation of a new db change + documentation for all moving parts (db dump, process of running migration file on local instance, testing scraper - where to find script)
  • db naming conventions
  • buildQuery

Scraper:

  • documentation on understanding wrangler.toml files, how scrapers work, what to expect from them

Endpoint:

  • error codes and meanings GOOD PRACTICE - along with endpoint info.
  • rest endpoint
    • all files changed
    • areas of focus, things to look out for
    • what a typical change entails
  • graphql
    • difference between rest and graphql
    • example of implementation
    • where to test on docs page
      Testing:
      • testing throughout the process [db change -> endpoint]
主要言語
MDX
スター
0
フォーク
1
平均マージ
23日 5時間
マージ済み PR（30日）
1

環境構築

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

はじめの一歩

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

icssc/docs のほかの issue

icssc/docs の issue をすべて見る

似ている issue

Backend & API Design の issue をもっと見る

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

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