Skip to content
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.

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

Improve Contributor Setup Guide #514

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
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
68 changes: 51 additions & 17 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,28 @@
# Contributing to opentelemetry-cpp-contrib

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.
## Introduction

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 [Gitter](https://gitter.im/open-telemetry/opentelemetry-cpp).
Welcome to the opentelemetry-cpp-contrib repository! This project is an integral part of the broader OpenTelemetry ecosystem, providing additional instrumentation and tools to enhance C/C++ observability.

## Development
We greatly appreciate any contributions, no matter the size or scope. Please feel free to reach out to the OpenTelemetry C/C++ community on [slack](https://cloud-native.slack.com/archives/C01N3AT62SJ) with questions or for assistance.

TBD
## Prerequisites

### Build and Run Code Examples
[C++14](https://github.com/open-telemetry/opentelemetry-cpp/?tab=readme-ov-file#supported-c-versions) or higher

TBD
CMake 3.18 or higher

Git

## Pull Requests
## Workflow

### How to Send Pull Requests
-Use forked repo when contributing

Everyone is welcome to contribute code to `opentelemetry-cpp-contrib` via GitHub pull
requests (PRs).
-Follow the OpenTelemetry C++ SDK contributing guidelines

-Write clear, concise commit messages

## Local Run/Build

To create a new PR, fork the project in GitHub and clone the upstream repo:

Expand All @@ -46,16 +47,49 @@ git push fork feature

Open a pull request against the main `opentelemetry-cpp-contrib` repo.

### How to Receive Comments
### Build and Run Code Examples

TBD

## Testing

TBD

## Contributing Rules

Follow the OpenTelemetry [C++ SDK coding standards](https://github.com/open-telemetry/opentelemetry-cpp?tab=readme-ov-file#supported-c-versions)

Include tests for new features or bug fixes


## How to Receive Comments

* If the PR is not ready for review, please put `[WIP]` in the title, tag it
as `work-in-progress`, or mark it as [`draft`](https://github.blog/2019-02-14-introducing-draft-pull-requests/).
* Make sure [CLA](https://identity.linuxfoundation.org/projects/cncf) is
signed and CI is clear.

## How to Get PRs Merged

Address any reviewer

Ensure all tests pass

The maintainers will squash and merge your commit when approved



## Further Help

The OpenTelemetry C/C++ special interest group (SIG) meets regularly.

See the puclic meeting notes via the [README](https://github.com/open-telemetry/opentelemetry-cpp?tab=readme-ov-file#contributing) by following the link to the google doc.

Link to join SIG meets also available in the README

For more info and help, join the meeting or get in touch on the [CNCF Slack channel for opentelemetry-cpp](https://cloud-native.slack.com/archives/C01N3AT62SJ).

### How to Get PRs Merged

This section needs to be written.

## Useful Resources

Expand Down