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

Make it clear that the library is not stable #1868

Closed
NickUfer opened this issue Jun 6, 2024 · 2 comments
Closed

Make it clear that the library is not stable #1868

NickUfer opened this issue Jun 6, 2024 · 2 comments

Comments

@NickUfer
Copy link

NickUfer commented Jun 6, 2024

When developers open the main page and read the README of this project for the first time everything, seems like this library is stable, which is not the case.

Please add a note at the top which makes it clear that this project is not even in beta yet (according to #1678).

@cijothomas
Copy link
Member

https://github.com/open-telemetry/opentelemetry-rust?tab=readme-ov-file#project-status -- is this sufficient?
Is there anything in crates.io to mark stability status?

@cijothomas
Copy link
Member

https://github.com/open-telemetry/opentelemetry-rust/blob/main/VERSIONING.md#policy it is also documented that the repo follows semver2.0.
And no crates have reached 1.0 - which is a reasonable way of communicating that breaking changes are possible.
If there are other ideas, happy to explore. Closing this issue for now.

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

No branches or pull requests

2 participants