From 37379acdd41b352a50b3cb0aac45670122a3695f Mon Sep 17 00:00:00 2001 From: Markus Bechter Date: Tue, 10 Dec 2024 10:49:47 +0100 Subject: [PATCH] docs: introduce incubation repositories This PR describes the role and usage of incubation repositories. Issue-ref: see #56 --- docs/features/integration/index.rst | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/docs/features/integration/index.rst b/docs/features/integration/index.rst index f4ea9aa..a3692d3 100644 --- a/docs/features/integration/index.rst +++ b/docs/features/integration/index.rst @@ -58,6 +58,30 @@ Optional repositories: - repositories containing implementation of particular features +Incubation repositories +======================= + +For early evaluation of existing implementations and prototypes we introduce +so called `incubation repositories`. +They should serve as a prototyping area where developers can share and build +code with only limited restrictions such as quality KPIs, review processes, etc. + +Incubation repositories are indicated by the suffix `inc_` in the repo name. + +Any incubation repository shall evolve over time towards a fully functional +bazel module, which can be integrated via an additonal dependency in the main +build. + +If a repo has reached this state and the concept is approved in general the +content can be used as input for the `score` repository, where the development +according to the defined process happens. In this stage the content +shall still be disabled via a bazel `feature flag` with the following the +nameing convention `//experimental_[feature]`. +The `experimental`-suffix indicates to the user that +this functionality is not yet ready for series production. +Additionally the relevant code might not meet all required quality KPIs. + + References ==========