envoyproxy/envoy

API stability proposal

Open

#3.390 geöffnet am 15. Mai 2018

Auf GitHub ansehen
 (12 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)C++ (5.373 Forks)batch import
area/communityhelp wanted

Repository-Metriken

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

Beschreibung

This is an extension of the conversation started in: https://docs.google.com/document/d/1eDQQSxqx2khTXfa2vVm4vqkyRwXYkPzZCcbjxJ2_AvA/edit?ts=5af97a4e

Ultimately, we would like to stabilize the API and have a deprecation period like we do for config changes. Getting there is going to take a bunch of thought and a solid plan. We also need to make sure we don't reduce velocity when the project is still relatively young.

Related to https://github.com/envoyproxy/envoy/issues/827

cc @brian-pane @htuch @alyssawilk @envoyproxy/maintainers

Contributor Guide

Research-Richtung
Lesen Sie den verlinkten Google Doc Vorschlag und Issue #827, um den Kontext der API Stabilität zu verstehen. Identifizieren Sie den aktuellen Zustand der API und schlagen Sie Schritte für eine Abkündigungsphase vor.
Tech Stack
cpp
Domain
backendapi
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 Tage
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
Understanding of Envoy's API and configuration
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
30