envoyproxy/envoy

Improve documentation for WIP extensions

Open

#23 732 ouverte le 28 oct. 2022

Voir sur GitHub
 (3 commentaires) (0 réactions) (0 assignés)C++ (5 373 forks)batch import
area/docsarea/extensionhelp wanted

Métriques du dépôt

Stars
 (27 997 stars)
Métriques de merge PR
 (Merge moyen 8j) (378 PRs mergées en 30 j)

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.

Guide contributeur

Direction de recherche
Consultez le guide du développeur actuel dans api/STYLE.md, en particulier la section sur l'ajout de configurations d'extension. Identifiez où les extensions WIP (Work In Progress) sont mentionnées et notez que le CI impose une documentation publique. Proposez des modifications pour clarifier que les extensions WIP nécessitent également une documentation publique. Consultez les commentaires de l'issue pour tout contexte supplémentaire.
Stack technique
Aucun
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Plutôt claire
Prérequis
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75