|
| 1 | +# Technical Review and Specification Conformance for ${Language}/${SIGNAL}/${MAJOR_VERSION} library |
| 2 | + |
| 3 | +Technical Committee Sponsor(s): [] |
| 4 | + |
| 5 | +Expected Release Date: [] |
| 6 | + |
| 7 | +Expected Version Number: [] |
| 8 | + |
| 9 | +Spec Compliance Matrix is up to date: [Permanent link to the matrix] |
| 10 | + |
| 11 | +Versioning And Stability Document: [Link to version document] |
| 12 | + |
| 13 | +Public Code Documentation: [Link to godoc, javadoc, etc.] |
| 14 | + |
| 15 | +Public Examples: [Link to couple of official usage examples] |
| 16 | + |
| 17 | +Discovered Issues: [List of filed issues by the TC members during the review process] |
| 18 | + |
| 19 | +## TODOs |
| 20 | + |
| 21 | +This section must be deleted when the PR for starting the review is opened, |
| 22 | +but it contains a list of important TODOs that maintainers MUST do before starting the process. |
| 23 | + |
| 24 | +The Language Maintainers MUST: |
| 25 | + |
| 26 | +* Prior to starting the review, update the |
| 27 | +[compliance matrix](https://github.com/open-telemetry/opentelemetry-specification/blob/main/spec-compliance-matrix.md) |
| 28 | +for that language/signal. |
| 29 | +* Each language implementation MUST follow |
| 30 | +[the versioning and stability requirements](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/versioning-and-stability.md) |
| 31 | +and prepare the public documentation about the versioning and stability guarantees. |
| 32 | +* Work with a Technical Committee Sponsor(s) during review. The Technical |
| 33 | +Committee members are not language experts, and it is expected to work with the |
| 34 | +language maintainers and/or invited language experts to perform this review |
| 35 | +process. Language maintainers SHOULD respond to any question during the review |
| 36 | +time in a reasonable amount of time to not delay the review process. |
| 37 | + |
| 38 | +It is highly recommended to have at least 2 members of the Technical Committee |
| 39 | +as sponsors. Any Technical Committee can be a sponsor, and any Technical |
| 40 | +Committee member can provide feedback during the review process. |
| 41 | + |
| 42 | +Technical Committee Sponsor(s) MUST: |
| 43 | + |
| 44 | +* Do the due diligence and review the public documentation and examples, and |
| 45 | +ensure specification conformance. |
| 46 | +* Ensure conformance with the versioning and stability document. |
| 47 | +* Ensure consistent names across implementations (e.g. TraceId vs GlobalId) |
| 48 | +* Avoid confusions across implementation (e.g same function returns has different behaviors) |
| 49 | +* Ensure no experimental features (signals) are part of the released packages (e.g. api, sdk, etc.). |
| 50 | + |
| 51 | +The OpenTelemetry Technical Committee MUST attend one of the language SIG |
| 52 | +meetings and have a public discussion with the language maintainers to discuss |
| 53 | +any issues found during the review process. |
0 commit comments