|
1 | | -MyGet: [](https://www.myget.org/feed/opencensus/package/nuget/OpenCensus) |
| 1 | +# OpenCensus .NET SDK - distributed tracing and stats collection framework |
2 | 2 |
|
3 | | -# OpenCensus .NET SDK |
| 3 | +[![Gitter chat][gitter-image]][gitter-url] |
| 4 | +MyGet: [![MyGet Nightly][opencensus-myget-image]][opencensus-myget-url] |
4 | 5 |
|
| 6 | +OpenCensus is a toolkit for collecting application performance and behavior data. It currently |
| 7 | +includes 3 APIs: stats, tracing and tags. |
5 | 8 |
|
| 9 | +The library is in [Beta](#versioning) stage and APIs are expected to be mostly stable. The |
| 10 | +library is expected to move to [GA](#versioning) stage after v1.0.0 major release. |
| 11 | + |
| 12 | +Please join [gitter](https://gitter.im/census-instrumentation/Lobby) for help or feedback on this |
| 13 | +project. |
| 14 | + |
| 15 | +We encourage contributions. Use tags [up-for-grabs](https://github.com/census-instrumentation/opencensus-csharp/issues?q=is%3Aissue+is%3Aopen+label%3Aup-for-grabs) and [good first issue](https://github.com/census-instrumentation/opencensus-csharp/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) to get started with the project. Follow [CONTRIBUTING](CONTRIBUTING.md) guide to report issues or submit a proposal. |
| 16 | + |
| 17 | +## OpenCensus Quickstart |
| 18 | + |
| 19 | +TBD |
| 20 | + |
| 21 | +## Versioning |
| 22 | + |
| 23 | +This library follows [Semantic Versioning][semver]. |
| 24 | + |
| 25 | +**GA**: Libraries defined at a GA quality level are stable, and will not introduce |
| 26 | +backwards-incompatible changes in any minor or patch releases. We will address issues and requests |
| 27 | +with the highest priority. If we were to make a backwards-incompatible changes on an API, we will |
| 28 | +first mark the existing API as deprecated and keep it for 18 months before removing it. |
| 29 | + |
| 30 | +**Beta**: Libraries defined at a Beta quality level are expected to be mostly stable and we're |
| 31 | +working towards their release candidate. We will address issues and requests with a higher priority. |
| 32 | +There may be backwards incompatible changes in a minor version release, though not in a patch |
| 33 | +release. If an element is part of an API that is only meant to be used by exporters or other |
| 34 | +opencensus libraries, then there is no deprecation period. Otherwise, we will deprecate it for 18 |
| 35 | +months before removing it, if possible. |
| 36 | + |
| 37 | + |
| 38 | +[gitter-image]: https://badges.gitter.im/census-instrumentation/lobby.svg |
| 39 | +[gitter-url]: https://gitter.im/census-instrumentation/lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge |
| 40 | +[opencensus-myget-image]: https://img.shields.io/myget/opencensus/vpre/OpenCensus.svg |
| 41 | +[opencensus-myget-url]: https://www.myget.org/feed/opencensus/package/nuget/OpenCensus |
| 42 | +[semver]: http://semver.org/ |
0 commit comments