Skip to content
This repository has been archived by the owner on Dec 6, 2024. It is now read-only.

Commit

Permalink
Merge remote-tracking branch 'profile/main' into profiling
Browse files Browse the repository at this point in the history
  • Loading branch information
petethepig committed Jul 26, 2023
2 parents d3b7479 + c454d6d commit 54bba7a
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,19 @@ and the corresponding Language Independent Interface Types ([.proto files](opent

## Language Independent Interface Types

The proto files can be consumed as GIT submodules or copied and built directly in the consumer project.
The `.proto` files can be consumed as GIT submodules or copied and built directly into the consumer project.

The compiled files are published to central repositories (Maven, ...) from OpenTelemetry client libraries.

See [contribution guidelines](CONTRIBUTING.md) if you would like to make any changes.

## OTLP/JSON

See additional requirements for [OTLP/JSON wire representation here](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/otlp.md#json-protobuf-encoding).
For additional requirements regarding the OTLP/JSON wire representation, refer to [OTLP/JSON wire representation here](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/otlp.md#json-protobuf-encoding).

## Generate gRPC Client Libraries

To generate the raw gRPC client libraries, use `make gen-${LANGUAGE}`. Currently supported languages are:
To generate the raw gRPC client libraries, use the command `make gen-${LANGUAGE}`. The currently supported languages are:

* cpp
* csharp
Expand All @@ -33,8 +33,8 @@ To generate the raw gRPC client libraries, use `make gen-${LANGUAGE}`. Currently

## Maturity Level

1.0.0 and newer releases from this repository may contain unstable (alpha or beta)
components as indicated by the Maturity table below.
Releases 1.0.0 and newer releases from this repository may contain unstable (alpha or beta)
components as indicated by the Maturity table below:

| Component | Binary Protobuf Maturity | JSON Maturity |
| --------- |--------------- | ------------- |
Expand All @@ -56,7 +56,7 @@ Components marked `Stable` provide the following guarantees:
- Service method names will not change. [from 1.0.0]
- Service method parameter names will not change. [from 1.0.0]
- Service method parameter types and return types will not change. [from 1.0.0]
- Service method kind (unary vs streaming) will not change.
- Service method kind (unary vs. streaming) will not change.
- Names of messages and enums will not change. [from 1.0.0]
- Numbers assigned to enum choices will not change.
- Names of enum choices will not change. [from 1.0.0]
Expand All @@ -66,7 +66,7 @@ Components marked `Stable` provide the following guarantees:
- `optional` and `repeated` declarators of existing fields will not change. [from 1.0.0]
- No existing symbol will be deleted. [from 1.0.0]

Note: guarantees marked [from 1.0.0] will go into effect when this repository is tagged
Note: The guarantees marked as [from 1.0.0] will go into effect when this repository is tagged
with version number 1.0.0.

The following additive changes are allowed:
Expand All @@ -87,7 +87,7 @@ is generated from the .proto files by any particular code generator.

## Experiments

In some cases we are trying to experiment with different features. In this case,
In some cases, we are trying to experiment with different features. In this case,
we recommend using an "experimental" sub-directory instead of adding them to any
protocol version. These protocols should not be used, except for
development/testing purposes.
Expand Down

0 comments on commit 54bba7a

Please sign in to comment.