envoyproxy/envoy

Improve documentation for WIP extensions

Open

#23,732 opened on Oct 28, 2022

View on 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
 (Avg merge 8d) (378 merged PRs in 30d)

Description

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.

Contributor guide

Research direction
Update the developer guide in api/STYLE.md to clarify that extensions with wip code must have public documentation, as enforced by CI.
Tech stack
None
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75