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

Initial readme and contributing docs #3

Merged
merged 3 commits into from
Oct 15, 2019
Merged

Initial readme and contributing docs #3

merged 3 commits into from
Oct 15, 2019

Conversation

reyang
Copy link
Member

@reyang reyang commented Oct 2, 2019

as title

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
Copy link
Member

@tigrannajaryan tigrannajaryan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM (after addressing comments from @z1c0).

Comment on lines +1 to +23
# OpenTelemetry C/C++
[![Gitter chat][gitter-image]][gitter-url]

[gitter-image]: https://badges.gitter.im/open-telemetry/opentelemetry-cpp.svg
[gitter-url]: https://gitter.im/open-telemetry/opentelemetry-cpp?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge

The C/C++ [OpenTelemetry](https://opentelemetry.io/) client.

## Installation

TBD

## Quick Start

TBD

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md)

## Release Schedule

OpenTelemetry C/C++ is under active development.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this supposed to be a combined library for both C and C++ users? Are C users/libraries willing to depend on a C++ runtime for their libraries/products? If this is not the case (which I hope), please do not mix C into the naming, and use just "OpenTelemetry C++"

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a "to-be-discussed" topic for our 1st community meeting.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I could imagine the potential-future C API belongs in its own repository.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, we've discussed this during the community meeting.
For now we will use this repo for the C++ SDK, and build a C API (no exception, no STL in the function signature) on top of the C++ SDK.
Later we might want to split the C API to its own repo.

Comment on lines +1 to +23
# OpenTelemetry C/C++
[![Gitter chat][gitter-image]][gitter-url]

[gitter-image]: https://badges.gitter.im/open-telemetry/opentelemetry-cpp.svg
[gitter-url]: https://gitter.im/open-telemetry/opentelemetry-cpp?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge

The C/C++ [OpenTelemetry](https://opentelemetry.io/) client.

## Installation

TBD

## Quick Start

TBD

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md)

## Release Schedule

OpenTelemetry C/C++ is under active development.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I could imagine the potential-future C API belongs in its own repository.

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
@reyang reyang merged commit d79a27c into open-telemetry:master Oct 15, 2019
0x4b pushed a commit to 0x4b/opentelemetry-cpp that referenced this pull request Jul 31, 2020
GerHobbelt pushed a commit to GerHobbelt/opentelemetry-cpp that referenced this pull request Jun 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants