open-telemetry / opentelemetry-cpp

The OpenTelemetry C++ Client
https://opentelemetry.io/
Apache License 2.0
890 stars 423 forks source link

[ADMIN] CONTRIBUTORS WELCOME #3068

Open marcalff opened 1 month ago

marcalff commented 1 month ago

This issue lists areas that are good entry points to start contributing to opentelemetry-cpp.

For each issue, see the issue comments for details.

Functional

Typically, features touching a functional area requires to dive into the code, but do not need changes in the infrastructure, like CI, workflows, compilers, platforms, makefiles ... This is a good opportunity to learn the C++ code itself. The size of the code affected varies by feature.

All signals

Typically, changes affecting all signals at once are using the same pattern, applied everywhere. The change is limited in scope, but touches multiple parts. This is a good opportunity to learn how to apply design or coding pattern to an existing code base.

Metrics signal

Typically, changes affecting the metrics signal are more involved on the functional part (time series, aggregation). This is a good opportunity to understand in depth a component, with clear boundaries.

Specific areas

Typically, features touching a specific area do not require to understand the whole code base, but only a well defined subset. This is a good opportunity to learn the development process (git, PR, review, merge) as well as the affected code.

Code health

This area requires to change CI/CD scripts to improve the build process. This is a very good opportunity to learn the github CI workflow, to implement new tooling.

Include-what-you-use

Iterative changes, to expand coverage to the entire code base.

Clang-tidy

Iterative changes, to expand coverage to the entire code base.

Cpp-check

Doxygen

Test coverage

This area is a very good opportunity to learn docker to execute tests in a container environment.

Documentation

This is internal documentation, for maintainers. We need to document internal processes (like, how to do a release, an upgrade, a deprecation, ...), as well as feature design (explain how xyz works) at high level, to understand the code base.

Too late

Fixed already:

github-actions[bot] commented 1 month ago

This issue is available for anyone to work on. Make sure to reference this issue in your pull request. :sparkles: Thank you for your contribution! :sparkles:

brown-eric commented 1 month ago

Hey, how can I help on this issue?

ThomsonTan commented 1 month ago

Hey, how can I help on this issue?

Could you please add comments on which issue you are interested? We can assign it to you to look into.

brown-eric commented 1 month ago

Which do you recommend? I'm new to this and would like to contribute for the first time! I have an assignment to do so and would love to be able to help this project #a little bit