Skip to content

Commit 6053ca1

Browse files
Improve Contributor Setup Guide (open-telemetry#514)
1 parent fd0554b commit 6053ca1

File tree

1 file changed

+51
-17
lines changed

1 file changed

+51
-17
lines changed

CONTRIBUTING.md

Lines changed: 51 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,28 @@
11
# Contributing to opentelemetry-cpp-contrib
22

3-
The OpenTelemetry C/C++ special interest group (SIG) meets regularly. See the
4-
OpenTelemetry [community](https://github.com/open-telemetry/community#cc-sdk)
5-
repo for information on this and other language SIGs.
3+
## Introduction
64

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.
106

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.
128

13-
TBD
9+
## Prerequisites
1410

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
1612

17-
TBD
13+
CMake 3.18 or higher
14+
15+
Git
1816

19-
## Pull Requests
17+
## Workflow
2018

21-
### How to Send Pull Requests
19+
-Use forked repo when contributing
2220

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
2526

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

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

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

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
5066

5167
* If the PR is not ready for review, please put `[WIP]` in the title, tag it
5268
as `work-in-progress`, or mark it as [`draft`](https://github.blog/2019-02-14-introducing-draft-pull-requests/).
5369
* Make sure [CLA](https://identity.linuxfoundation.org/projects/cncf) is
5470
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).
5591

56-
### How to Get PRs Merged
5792

58-
This section needs to be written.
5993

6094
## Useful Resources
6195

0 commit comments

Comments
 (0)