Skip to content

Conversation

RichardChukwu
Copy link

@RichardChukwu RichardChukwu commented Feb 10, 2025

part of open-telemetry/sig-contributor-experience#31

Changes

This PR enhances the CONTRIBUTING.md file by improving its structure, clarifying build prerequisites, and addressing common build issues. The goal is to make it easier for first-time contributors to get started with opentelemetry-cpp.

Key Change:

✅ Added a Prerequisites Section

  • Listed required tools with version recommendations, including C++ compilers, CMake, Bazel, clang-format, and markdownlint-cli.
  • Specified Bazel 7.1.1 as the recommended version for building examples.

Why These Changes?

The previous version lacked explicit versioning details for Bazel, leading to build errors.
The new structure provides a clearer path for first-time contributors.

For significant contributions please make sure you have completed the following items:

  • CHANGELOG.md updated for non-trivial changes

@RichardChukwu RichardChukwu requested a review from a team as a code owner February 10, 2025 08:29
@netlify
Copy link

netlify bot commented Feb 10, 2025

Deploy Preview for opentelemetry-cpp-api-docs canceled.

Name Link
🔨 Latest commit 21e416e
🔍 Latest deploy log https://app.netlify.com/sites/opentelemetry-cpp-api-docs/deploys/67b4b3be90ff7a0008eb982c

@codecov
Copy link

codecov bot commented Feb 10, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.96%. Comparing base (821ad9e) to head (21e416e).

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #3264   +/-   ##
=======================================
  Coverage   87.96%   87.96%           
=======================================
  Files         205      205           
  Lines        6407     6407           
=======================================
  Hits         5635     5635           
  Misses        772      772           

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant