envoyproxy/envoy

API stability proposal

Ouverte

#3 390 ouverte le 15 mai 2018

Voir sur GitHubGuide contributeur
 (12 commentaires) (0 réaction) (0 personne assignée)C++ (5 373 forks)batch import
area/communityhelp wanted

Métriques du dépôt

Stars
 (27 997 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

Description

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

Guide contributeur

Direction de recherche
Consultez la proposition Google Doc liée et l'issue #827 pour comprendre le contexte de la stabilité de l'API. Identifiez l'état actuel de l'API et proposez des étapes pour une période de dépréciation.
Stack technique
cpp
Domaine
backendapi
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.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-2 jours
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
Understanding of Envoy's API and configuration
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
30