envoyproxy/envoy

Improve documentation for WIP extensions

Open

#23.732 aberto em 28 de out. de 2022

Ver no GitHub
 (3 comments) (0 reactions) (0 assignees)C++ (5.373 forks)batch import
area/docsarea/extensionhelp wanted

Métricas do repositório

Stars
 (27.997 stars)
Métricas de merge de PR
 (Mesclagem média 8d) (378 fundiu PRs em 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.

Guia do colaborador

Direção de pesquisa
Revise o guia do desenvolvedor atual em api/STYLE.md, especialmente a seção sobre adicionar configurações de extensão. Identifique onde as extensões WIP (Work In Progress) são mencionadas e observe que o CI impõe a documentação pública. Proponha alterações para esclarecer que as extensões WIP também precisam de documentação pública. Consulte os comentários da issue para obter qualquer contexto adicional.
Pilha de tecnologia
None
Domain
documentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Principalmente claro
Prerequisites
Git
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
75