envoyproxy/envoy

Improve documentation for WIP extensions

Open

#23,732 opened on 2022年10月28日

GitHub で見る
 (3 comments) (0 reactions) (0 assignees)C++ (5,373 forks)batch import
area/docsarea/extensionhelp wanted

Repository metrics

Stars
 (27,997 stars)
PR merge metrics
 (平均マージ 8d) (30d で 378 merged PRs)

説明

Title: Improve documentation for WIP extensions

Description: It is not clear from current developer documentation that extensions with wip code should have public documentation. This is currently enforced by CI. We should better clarify developer guide on how to add wip extensions.

コントリビューターガイド

調査方針
api/STYLE.md にある現在の開発者ガイド、特に拡張設定の追加に関するセクションを確認してください。WIP（作業中）拡張について言及されている箇所を特定し、CI が公開ドキュメントを強制する点に注意してください。WIP 拡張にも公開ドキュメントが必要であることを明確にするための変更を提案してください。追加の文脈については issue のコメントを参照してください。
技術スタック
なし
領域
documentation
Issue 種別
ドキュメント
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3時間
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
おおむね明確
前提条件
Git
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
75