Skip to content
This repository was archived by the owner on Dec 18, 2023. It is now read-only.

Commit 15f2e3a

Browse files
readme and contributing (#24)
1 parent e339c7b commit 15f2e3a

3 files changed

Lines changed: 85 additions & 2 deletions

File tree

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Unreleased
2+
3+
- Initial version of SDK published. It is based on contribution from Pivotal from https://github.com/SteeltoeOSS/Management/tree/dev/src/Steeltoe.Management.OpenCensus
4+

CONTRIBUTING.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Report a bug
2+
3+
Reporting bug is an important contribution. Please make sure to include:
4+
5+
- expected and actual behavior.
6+
- dotnet version that application is compiled on and running with (it may be different - for instance target framework was set to .NET 4.6 for compilaiton, but applicaiton is running on .NET 4.7.3).
7+
- exception call stack and other artifacts.
8+
- if possible - reporo application and steps to reproduce.
9+
10+
# How to contribute
11+
12+
## Before started
13+
14+
In order to protect both you and ourselves, you will need to sign the [Contributor License Agreement](https://cla.developers.google.com/clas).
15+
16+
## Build
17+
18+
You can use Visual Studio 2017 or VS code to contribute. Just open root folder or `OpenCensus.sln` in your editor and follow normal development process.
19+
20+
To build from command line you need `dotnet` version `2.0+`.
21+
22+
```
23+
dotnet build OpenCensus.sln
24+
```
25+
26+
## Test
27+
28+
You can use Visual Studio 2017 or VS code to test your contribution. Open root folder or `OpenCensus.sln` in your editor and follow normal development process.
29+
30+
To test from command line you need `dotnet` version `2.0+`.
31+
32+
```
33+
dotnet test OpenCensus.sln
34+
```
35+
36+
## Proposing changes
37+
38+
Create a Pull Request with your changes. Please add any user-visible changes to
39+
`CHANGELOG.md`. The continuous integration build will run the tests and static
40+
analysis. It will also check that the pull request branch has no merge commits.
41+
When the changes are accepted, they will be merged or cherry-picked by an
42+
OpenCensus repository maintainers.

README.md

Lines changed: 39 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,42 @@
1-
MyGet: [![MyGet Nightly](https://img.shields.io/myget/opencensus/vpre/OpenCensus.svg)](https://www.myget.org/feed/opencensus/package/nuget/OpenCensus)
1+
# OpenCensus .NET SDK - distributed tracing and stats collection framework
22

3-
# OpenCensus .NET SDK
3+
[![Gitter chat][gitter-image]][gitter-url]
4+
MyGet: [![MyGet Nightly][opencensus-myget-image]][opencensus-myget-url]
45

6+
OpenCensus is a toolkit for collecting application performance and behavior data. It currently
7+
includes 3 APIs: stats, tracing and tags.
58

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

Comments
 (0)