From f78d35f2f4b5797bae2087fe99e381ce83676761 Mon Sep 17 00:00:00 2001 From: Sergey Kanzhelev Date: Tue, 9 Jun 2020 10:24:23 -0700 Subject: [PATCH] propose experimental folder (#632) * propose experimental folder * misspell * update wording * require experimental note in files * Update experimental/README.md Co-authored-by: Armin Ruech * Update experimental/README.md Co-authored-by: Armin Ruech * Update experimental/README.md Co-authored-by: Reiley Yang Co-authored-by: Armin Ruech Co-authored-by: Reiley Yang --- experimental/README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 experimental/README.md diff --git a/experimental/README.md b/experimental/README.md new file mode 100644 index 00000000000..466bbf4d943 --- /dev/null +++ b/experimental/README.md @@ -0,0 +1,15 @@ +# Experimental features + +This folder will be used to develop experimental features. Experimental status allows to develop components that are on trajectory to become a part of a main project while allowing a faster cadence of merges and collaboration. + +Experimental features must be: + +- Implementable as a plugin to OpenTelemetry components (API, SDK, collector, etc.). +- Be in active development or testing. +- Approved as a general direction via OTEP process. + +All files in experimental folder must have a note about it's experimental status to avoid any confusion. + +Experimental status precedes the alpha version. All changes in the experimental folder go through the regular review process. Changes are allowed to be merged faster as completeness of a solution is not a requirement. Approval means that proposed changes are OK for experimentation. + +When the feature or parts of it are developed far enough to declare them as an alpha version of a main project and move out of the experimental status, it must go through a **new** OTEP PR and it must be expected that design and APIs will be changed. In fact, the same people who approved the experiment may likely be the most critical reviewers. It demonstrates an interest and involvement, not critique.