Azure / Azure/openapi-diff

Docs on the CLI or the JS API?

オープン
#348 コメント 0 件 リアクション 3 件 担当者 0 名 GitHub で見る
主要言語
C#
スター
290
フォーク
50
平均マージ
5日 13時間
マージ済み PR(30日)
5

説明

Hi there! I just stumbled upon this library recently and it looks excellent — are there any public-facing docs on the CLI or the JS API?

If you're accepting external contributors for documentation, let me know. I'd be happy to at least help set up some sort of doc generation process (e.g., based on the JSDocs) — I want to be mindful of not adding on to the maintenance burden 🙂 thanks!

コントリビューションガイド

コントリビューションガイドを開く

調査の方向性

この issue では、調査対象の入り口として CLI、JS API、JSDocs が挙げられています。まず、それぞれについて公開向けのドキュメントが存在するかを確認してください。完了とするには、要求されたインターフェースをカバーしつつ、不明確なメンテナンス負担を追加しない、合意済みのドキュメント範囲または生成プロセスが必要です。

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

評価

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

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

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