Skip to content

Commit d79a27c

Browse files
authored
Initial readme and contributing docs (open-telemetry#3)
1 parent a7adf0f commit d79a27c

File tree

2 files changed

+107
-0
lines changed

2 files changed

+107
-0
lines changed

CONTRIBUTING.md

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
# Contributing to opentelemetry-cpp
2+
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.
6+
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).
10+
11+
See the [community membership document](https://github.com/open-telemetry/community/blob/master/community-membership.md)
12+
on how to become a [**Member**](https://github.com/open-telemetry/community/blob/master/community-membership.md#member),
13+
[**Approver**](https://github.com/open-telemetry/community/blob/master/community-membership.md#approver)
14+
and [**Maintainer**](https://github.com/open-telemetry/community/blob/master/community-membership.md#maintainer).
15+
16+
## Development
17+
18+
TBD
19+
20+
## Pull Requests
21+
22+
### How to Send Pull Requests
23+
24+
Everyone is welcome to contribute code to `opentelemetry-cpp` via GitHub pull
25+
requests (PRs).
26+
27+
To create a new PR, fork the project in GitHub and clone the upstream repo:
28+
29+
```sh
30+
$ git clone https://github.com/open-telemetry/opentelemetry-cpp.git
31+
```
32+
33+
Add your fork as an origin:
34+
35+
```sh
36+
$ git remote add fork https://github.com/YOUR_GITHUB_USERNAME/opentelemetry-cpp.git
37+
```
38+
39+
Build:
40+
41+
TBD
42+
43+
Test:
44+
45+
TBD
46+
47+
Check out a new branch, make modifications and push the branch to your fork:
48+
49+
```sh
50+
$ git checkout -b feature
51+
# edit files
52+
$ git commit
53+
$ git push fork feature
54+
```
55+
56+
Open a pull request against the main `opentelemetry-cpp` repo.
57+
58+
### How to Receive Comments
59+
60+
* If the PR is not ready for review, please put `[WIP]` in the title, tag it
61+
as `work-in-progress`, or mark it as [`draft`](https://github.blog/2019-02-14-introducing-draft-pull-requests/).
62+
* Make sure [CLA](https://identity.linuxfoundation.org/projects/cncf) is signed and CI is clear.
63+
64+
### How to Get PRs Merged
65+
66+
A PR is considered to be **ready to merge** when:
67+
* It has received two approvals from [Approvers](https://github.com/open-telemetry/community/blob/master/community-membership.md#approver)
68+
/ [Maintainers](https://github.com/open-telemetry/community/blob/master/community-membership.md#maintainer)
69+
(at different companies).
70+
* Major feedback items/points are resolved.
71+
* It has been open for review for at least one working day. This gives people
72+
reasonable time to review.
73+
* Trivial changes (typo, cosmetic, doc, etc.) don't have to wait for one day.
74+
* Urgent fixes can take exceptions as long as it has been actively communicated.
75+
76+
Any Approver / Maintainer can merge the PR once it is **ready to merge**.
77+
78+
## Style Guide
79+
80+
TBD

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# OpenTelemetry C/C++
2+
[![Gitter chat][gitter-image]][gitter-url]
3+
4+
[gitter-image]: https://badges.gitter.im/open-telemetry/opentelemetry-cpp.svg
5+
[gitter-url]: https://gitter.im/open-telemetry/opentelemetry-cpp?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
6+
7+
The C/C++ [OpenTelemetry](https://opentelemetry.io/) client.
8+
9+
## Installation
10+
11+
TBD
12+
13+
## Quick Start
14+
15+
TBD
16+
17+
## Contributing
18+
19+
See [CONTRIBUTING.md](CONTRIBUTING.md)
20+
21+
## Release Schedule
22+
23+
OpenTelemetry C/C++ is under active development.
24+
25+
The library is not yet _generally available_, and releases aren't guaranteed to
26+
conform to a specific version of the specification. Future releases will not
27+
attempt to maintain backwards compatibility with current releases.

0 commit comments

Comments
 (0)