microsoft / microsoft/OpenAPI.NET
Add conceptual docs for OpenAPI
オープン
まだ誰も着手していません。
type:documentation
type:epic
- 主要言語
- C#
- スター
- 1.6k
- フォーク
- 286
- 平均マージ
- 6時間 38分
- マージ済み PR（30日）
- 35
説明
- Include getting started docs & tutorials for OpenAPI Writers lib
- Include getting started docs & tutorials for Hidi tool and add scenario-based tutorials eg using Hidi with API manifest from Graph Explorer
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず、OpenAPI Writers ライブラリと Hidi ツールの既存のドキュメントのエントリポイントを特定します。両方について、入門およびチュートリアルで扱う内容を定義します。これには、Graph Explorer の API マニフェストと Hidi を使用するシナリオを含めます。両方のツールについて、概念ドキュメントと要求されたチュートリアルが追加されれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- csharp, openapi
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 42/100