You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
repo for information on this and other language SIGs.
3
+
## Introduction
6
4
7
-
See the [public meeting notes](https://docs.google.com/document/d/1i1E4-_y4uJ083lCutKGDhkpi3n4_e774SBLi9hPLocw/edit)
8
-
for a summary description of past meetings. To request edit access, join the
9
-
meeting or get in touch on [Gitter](https://gitter.im/open-telemetry/opentelemetry-cpp).
5
+
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.
10
6
11
-
## Development
7
+
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.
12
8
13
-
TBD
9
+
## Prerequisites
14
10
15
-
### Build and Run Code Examples
11
+
[C++14](https://github.com/open-telemetry/opentelemetry-cpp/?tab=readme-ov-file#supported-c-versions) or higher
16
12
17
-
TBD
13
+
CMake 3.18 or higher
14
+
15
+
Git
18
16
19
-
## Pull Requests
17
+
## Workflow
20
18
21
-
### How to Send Pull Requests
19
+
-Use forked repo when contributing
22
20
23
-
Everyone is welcome to contribute code to `opentelemetry-cpp-contrib` via GitHub pull
24
-
requests (PRs).
21
+
-Follow the OpenTelemetry C++ SDK contributing guidelines
22
+
23
+
-Write clear, concise commit messages
24
+
25
+
## Local Run/Build
25
26
26
27
To create a new PR, fork the project in GitHub and clone the upstream repo:
27
28
@@ -46,16 +47,49 @@ git push fork feature
46
47
47
48
Open a pull request against the main `opentelemetry-cpp-contrib` repo.
48
49
49
-
### How to Receive Comments
50
+
### Build and Run Code Examples
51
+
52
+
TBD
53
+
54
+
## Testing
55
+
56
+
TBD
57
+
58
+
## Contributing Rules
59
+
60
+
Follow the OpenTelemetry [C++ SDK coding standards](https://github.com/open-telemetry/opentelemetry-cpp?tab=readme-ov-file#supported-c-versions)
61
+
62
+
Include tests for new features or bug fixes
63
+
64
+
65
+
## How to Receive Comments
50
66
51
67
* If the PR is not ready for review, please put `[WIP]` in the title, tag it
52
68
as `work-in-progress`, or mark it as [`draft`](https://github.blog/2019-02-14-introducing-draft-pull-requests/).
53
69
* Make sure [CLA](https://identity.linuxfoundation.org/projects/cncf) is
54
70
signed and CI is clear.
71
+
72
+
## How to Get PRs Merged
73
+
74
+
Address any reviewer
75
+
76
+
Ensure all tests pass
77
+
78
+
The maintainers will squash and merge your commit when approved
79
+
80
+
81
+
82
+
## Further Help
83
+
84
+
The OpenTelemetry C/C++ special interest group (SIG) meets regularly.
85
+
86
+
See the public 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.
87
+
88
+
Link to join SIG meets also available in the README
89
+
90
+
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).
0 commit comments