Skip to content

Commit

Permalink
docs(ReadMe): explain versioning section
Browse files Browse the repository at this point in the history
  • Loading branch information
gaelreyrol committed Jan 17, 2025
1 parent 851252a commit 5b4ab49
Show file tree
Hide file tree
Showing 8 changed files with 4,964 additions and 3,273 deletions.
2 changes: 1 addition & 1 deletion .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true

[*.{nix,yml,yaml,yml.dist,md,lock}]
[*.{nix,yml,yaml,yml.dist,md,lock,json}]
indent_size = 2

[*.neon]
Expand Down
41 changes: 40 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,46 @@ Found a bug, have a suggestion for a new feature? Please read the [contribution

## Versioning

TBD
This section outlines how pre-release versions will be published until the first stable release is achieved and the goals for each stage.

Backward compatibility will not be provided during pre-release stages, as our focus is on progressing toward the stable release. Consequently, breaking changes, such as package upgrades and configuration modifications, may occur without notice.

### Alpha

The goal of the Alpha release is to achieve full integration of the tracing, metering, and logging services provided by the OpenTelemetry SDK.

To accomplish this:

- All services and their dependencies must be fully declared in the bundle configuration.
- Services should be easily overridden by user-defined service definitions following Symfony's dependency injection principles.

Once the services are functional according to OpenTelemetry SDK capabilities and Symfony's service definitions, this phase will be complete.

### Beta

The goal of the Beta release is to enable tracing instrumentation for a Symfony application, either automatically or selectively.

Instrumentation goals include:

- Allowing instrumentation of Symfony components through defined entry points.
- Providing automatic (opt-out) instrumentation, where components are instrumented by default, with the option to exclude specific components.
- Enabling selective instrumentation, allowing users to explicitly choose which components to instrument through provided APIs.

For more details on instrumentation requirements, refer to the [Traces Instrumentation Documentation](https://friendsofopentelemetry.github.io/opentelemetry-bundle/instrumentation/traces.html#components).

This phase will conclude once:

- All components are fully covered by instrumentation.
- Both automatic and selective configuration methods are implemented.

### Stable

To complete the Stable release, the following goals must be met:

- Full compliance with [OpenTelemetry Trace Semantic Conventions](https://opentelemetry.io/docs/specs/semconv/general/trace/).
- Stabilization of tracing instrumentation, incorporating feedback and addressing reported issues.
- Comprehensive test coverage for each component.
- A complete documentation set, covering tracing services, configurations, and bundle capabilities.

## Credits

Expand Down
Loading

0 comments on commit 5b4ab49

Please sign in to comment.