envoyproxy/envoy

API stability proposal

Open

#3,390 opened on May 15, 2018

View on GitHub
 (12 comments) (0 reactions) (0 assignees)C++ (5,373 forks)batch import
area/communityhelp wanted

Repository metrics

Stars
 (27,997 stars)
PR merge metrics
 (Avg merge 8d) (378 merged PRs in 30d)

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

Contributor guide

Research direction
Review the linked Google Doc proposal and issue #827 to understand the context of API stability. Identify the current state of the API and propose steps for a deprecation period.
Tech stack
cpp
Domain
backendapi
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
Understanding of Envoy's API and configuration
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30