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