envoyproxy/envoy

Improve documentation for WIP extensions

Open

#23,732 建立於 2022年10月28日

在 GitHub 查看
 (3 留言) (0 反應) (0 負責人)C++ (5,373 fork)batch import
area/docsarea/extensionhelp wanted

倉庫指標

Star
 (27,997 star)
PR 合併指標
 (平均合併 8天) (30 天內合併 378 個 PR)

描述

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
議題類型
文件
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 小時
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
活躍
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
大致清晰
前置要求
Git
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
75