Skip to content

Commit

Permalink
propose experimental folder (#632)
Browse files Browse the repository at this point in the history
* propose experimental folder

* misspell

* update wording

* require experimental note in files

* Update experimental/README.md

Co-authored-by: Armin Ruech <[email protected]>

* Update experimental/README.md

Co-authored-by: Armin Ruech <[email protected]>

* Update experimental/README.md

Co-authored-by: Reiley Yang <[email protected]>

Co-authored-by: Armin Ruech <[email protected]>
Co-authored-by: Reiley Yang <[email protected]>
  • Loading branch information
3 people authored Jun 9, 2020
1 parent 1729bc4 commit f78d35f
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions experimental/README.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit f78d35f

Please sign in to comment.