envoyproxy/envoy

Improve documentation for WIP extensions

Open

#23.732 aperta il 28 ott 2022

Vedi su GitHub
 (3 commenti) (0 reazioni) (0 assegnatari)C++ (5373 fork)batch import
area/docsarea/extensionhelp wanted

Metriche repository

Star
 (27.997 star)
Metriche merge PR
 (Merge medio 8g) (378 PR mergiate in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Rivedi la guida per sviluppatori attuale in api/STYLE.md, in particolare la sezione sull'aggiunta di configurazioni di estensione. Identifica dove vengono menzionate le estensioni WIP (Work In Progress) e nota che il CI applica la documentazione pubblica. Proponi modifiche per chiarire che anche le estensioni WIP necessitano di documentazione pubblica. Consulta i commenti dell'issue per eventuali contesti aggiuntivi.
Tech stack
Nessuno
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Abbastanza chiara
Prerequisiti
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75