diff --git a/CHANGELOG.md b/CHANGELOG.md index 90ea49e17c..4730752829 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -15,6 +15,11 @@ Increment the: ## [Unreleased] +#### [Documentation] +- Improved `CONTRIBUTING.md` structure for better readability. [#3264](https://github.com/open-telemetry/opentelemetry-cpp/pull/3264) +- Added **Prerequisites** section with required tool versions (including Bazel 7.1.1). + + * [SDK] Add tracer scope configurator [#3137](https://github.com/open-telemetry/opentelemetry-cpp/pull/3137) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bf837f6bd1..a9c060c85c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,14 +1,12 @@ # Contributing to opentelemetry-cpp -The OpenTelemetry C/C++ special interest group (SIG) meets regularly. See the -OpenTelemetry [community](https://github.com/open-telemetry/community#cc-sdk) +The OpenTelemetry C/C++ special interest group (SIG) meets regularly. +See the OpenTelemetry [community](https://github.com/open-telemetry/community#cc-sdk) repo for information on this and other language SIGs. -See the [public meeting -notes](https://docs.google.com/document/d/1i1E4-_y4uJ083lCutKGDhkpi3n4_e774SBLi9hPLocw/edit) +See the [public meeting notes](https://docs.google.com/document/d/1i1E4-_y4uJ083lCutKGDhkpi3n4_e774SBLi9hPLocw/edit) for a summary description of past meetings. To request edit access, join the -meeting or get in touch on -[Slack](https://cloud-native.slack.com/archives/C01N3AT62SJ). +meeting or get in touch on [Slack](https://cloud-native.slack.com/archives/C01N3AT62SJ). See the [community membership document](https://github.com/open-telemetry/community/blob/main/community-membership.md) @@ -18,6 +16,18 @@ on how to become a and [**Maintainer**](https://github.com/open-telemetry/community/blob/main/community-membership.md#maintainer). + +## Prerequisites + +Before contributing, ensure you have the following tools installed: + +- **C++ Compiler** (GCC 5+ or Clang 3.4+) +- **CMake** (version 3.12+) +- **Bazel** (version 7.1.1 for building examples) +- **clang-format** (version 10.0) +- **Docker** (for DevContainer setup) + + ## Development OpenTelemetry C++ uses the [Google naming @@ -271,8 +281,8 @@ the C++ repository. * [OpenTelemetry Specification](https://github.com/open-telemetry/opentelemetry-specification) - * The OpenTelemetry Specification describes the requirements and expectations - of for all OpenTelemetry implementations. + * The OpenTelemetry Specification describes the requirements and + expectations of for all OpenTelemetry implementations. * Read through the OpenTelemetry C++ documentation * The