rfcs: CockroachDB Feature Registry #72800
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
This change is |
(from the RFC body) This proposal document describes the CockroachDB Feature Registry, a proposed system for tracking CockroachDB features that helps our developers safely add, test, and evolve features in the database. The Feature Registry is a system of checks, tests, documentation and warnings that: - Nudges developers toward following the best practices for creating features in the codebase, like adding randomized testing, upgrade tests, telemetry, metrics, logs, feature flags, and so on. - Helps developers classify the maturity of their features via a maturity matrix, which configures the strictness of the checks against a feature, and helps advertise features to users based on their maturity - Reminds developers to register their new features in the registry as code is added to certain key packages This RFC was already reviewed in an earlier form in an internal Google Doc, [CockroachDB Feature Registry](https://docs.google.com/document/d/1Qczjq2n9OoYZsDVvM-C8aR059j31X0Y1we0EUEDmN4E/edit#) Release note: None
jordanlewis
force-pushed
the
feature-registry-rfc
branch
from
48ec852
to
6fd42c7
Compare
jordanlewis
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
(from the RFC body)
This proposal document describes the CockroachDB Feature Registry, a
proposed system for tracking CockroachDB features that helps our
developers safely add, test, and evolve features in the database. The
Feature Registry is a system of checks, tests, documentation and
warnings that:
features in the codebase, like adding randomized testing, upgrade tests,
telemetry, metrics, logs, feature flags, and so on.
matrix, which configures the strictness of the checks against a feature,
and helps advertise features to users based on their maturity
code is added to certain key packages
This RFC already received some reviews in an earlier form in an internal Google
Doc, CockroachDB Feature Registry
Release note: None