envoyproxy/envoy

Improve documentation for WIP extensions

Open

#23.732 geöffnet am 28. Okt. 2022

Auf GitHub ansehen
 (3 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)C++ (5.373 Forks)batch import
area/docsarea/extensionhelp wanted

Repository-Metriken

Stars
 (27.997 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 8T) (378 gemergte PRs in 30 T)

Beschreibung

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-Richtung
Überprüfe den aktuellen Entwicklerleitfaden unter api/STYLE.md, insbesondere den Abschnitt über das Hinzufügen von Erweiterungskonfigurationen. Identifiziere, wo WIP Erweiterungen (Work In Progress) erwähnt werden, und beachte, dass der CI öffentliche Dokumentation erzwingt. Schlage Änderungen vor, um klarzustellen, dass auch WIP Erweiterungen öffentliche Dokumentation benötigen. Konsultiere die Issue Kommentare für zusätzlichen Kontext.
Tech Stack
Keine
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Meist klar
Voraussetzungen
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75