Skip to content

Improve Contributor Guide #3264

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 7 commits into from
Closed

Improve Contributor Guide #3264

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
2524dba
Update CONTRIBUTING.md
RichardChukwu Feb 10, 2025
d0f047e
Update CHANGELOG.md
RichardChukwu Feb 10, 2025
4698741
Merge branch 'main' into main
RichardChukwu Feb 10, 2025
ed4b43a
Update CONTRIBUTING.md
RichardChukwu Feb 11, 2025
77b88a2
Merge branch 'main' into main
RichardChukwu Feb 14, 2025
d7997c0
Merge branch 'main' into main
RichardChukwu Feb 17, 2025
21e416e
Merge branch 'main' into main
RichardChukwu Feb 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
26 changes: 18 additions & 8 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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)
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down
Loading