Skip to content

Commit 6148831

Browse files
committed
Address feedback
Signed-off-by: Bogdan Drutu <bogdandrutu@gmail.com>
1 parent b39c532 commit 6148831

File tree

2 files changed

+10
-12
lines changed

2 files changed

+10
-12
lines changed

releases/new-telemetry-release-process-template.md releases/new-signal-release-process-template.md

+4-6
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
1-
# Technical Review and Specification Conformance for ${Language}/${TELEMETRY}/${MAJOR_VERSION} library
1+
# Technical Review and Specification Conformance for ${Language}/${SIGNAL}/${MAJOR_VERSION} library
22

33
Technical Committee Sponsor(s): []
44

5-
Status: [PROPOSAL|REJECTED|APPROVED]
6-
75
Expected Release Date: []
86

9-
Spec Compliance Matrix is up to date: [YES|NO]
7+
Spec Compliance Matrix is up to date: [Permanent link to the matrix]
108

119
Versioning And Stability Document: [LINK to version document]
1210

@@ -24,7 +22,7 @@ The Language Maintainers MUST:
2422

2523
* Prior to starting the review, update the
2624
[compliance matrix](https://github.com/open-telemetry/opentelemetry-specification/blob/main/spec-compliance-matrix.md)
27-
for that language/telemetry.
25+
for that language/signal.
2826
* Each language implementation MUST follow
2927
[the versioning and stability requirements](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/versioning-and-stability.md)
3028
and prepare the public documentation about the versioning and stability guarantees.
@@ -43,6 +41,6 @@ ensure specification conformance.
4341
* Ensure conformance with the versioning and stability document.
4442
* Ensure consistent names across implementations (e.g. TraceId vs Id)
4543
* Avoid confusions across implementation (e.g same function returns has different behaviors)
46-
* Ensure no experimental features (signals) are part of the main API package.
44+
* Ensure no experimental features (signals) are part of the released packages (e.g. api, sdk, etc.).
4745

4846
The OpenTelemetry Technical Committee MUST attend one of the language SIG meetings and have a public discussion with the language maintainers to discuss any issues found during the review process.

releases/new-telemetry-release-process.md releases/new-signal-release-process.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# New Telemetry Release Process
1+
# New Signal Release Process
22

33
This document defines the release requirements and process followed by the
44
OpenTelemetry libraries, along with the rules and procedures for meeting those
@@ -10,9 +10,9 @@ refer to the specification or the Collector in this document.
1010

1111
Every OpenTelmetry official major release MUST follow the release process
1212
proposed in this document. A "major release" refers to a new version of any
13-
telemetry type (adding a new telemetry type to an already released major version
14-
of the library, or a major version bump for an existing telemetry type) for
15-
OpenTelemetry client libraries.
13+
[signal](../specification/glossary.md#signals) (adding a new signal to an
14+
already released major version of the library, or a major version bump for an
15+
existing signal release) for OpenTelemetry client libraries.
1616

1717
The OpenTelemetry [Technical Committee](https://github.com/open-telemetry/community/blob/main/tech-committee-charter.md) (with guidance from language maintainers) is responsible to setup release dates
1818
and ensure quality standards of the official releases
@@ -32,8 +32,8 @@ commits to ensure that every decision will be made in less than 14 days after
3232
the process is started.
3333

3434
To begin the technical and specification compliance review language maintainers
35-
MUST submit a PR and complete this [template](new-telemetry-release-process-template.md).
36-
The name of the file MUST be `technical-specification-review-${language}.md`.
35+
MUST submit a PR and complete this [template](new-signal-release-process-template.md).
36+
The name of the file MUST be `release-review-${language}-${signal}.md`.
3737

3838
During the review process, breaking changes MAY be needed to comply with the
3939
specification, it is highly recommended to start the process as soon as possible,

0 commit comments

Comments
 (0)