Skip to content

Commit

Permalink
docs: introduce incubation repositories
Browse files Browse the repository at this point in the history
This PR describes the role and usage of incubation repositories.

Issue-ref: see #56
  • Loading branch information
ramceb committed Dec 10, 2024
1 parent 35a8498 commit 37379ac
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions docs/features/integration/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
==========

Expand Down

0 comments on commit 37379ac

Please sign in to comment.