open-telemetry
/
opentelemetry-dotnet
mirror of https://github.com/open-telemetry/opentelemetry-dotnet.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

update docs to explain how to work on metrics (#1756)

This commit is contained in:
Reiley Yang 2021-01-29 16:11:05 -08:00 committed by GitHub
parent 416a6c12f7
commit 568fbd73f4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 14 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
CONTRIBUTING.md
View File

@ -114,6 +114,14 @@ Add your fork as an origin:
git remote add fork https://github.com/YOUR_GITHUB_USERNAME/opentelemetry-dotnet.git
```
By default your work will be targeting the `main` branch. If you want to work on
the experimental metrics feature, please switch to the `metrics` feature branch:
```sh
# only do this when you want to work on the experimental metrics feature
git checkout metrics
```
Run tests:
```sh

9
README.md
View File

@ -21,9 +21,12 @@ Framework](https://dotnet.microsoft.com/download/dotnet-framework) except for
## Getting Started
If you are new here, please see getting started docs for
[logs](./docs/logs/getting-started/README.md),
[trace](./docs/trace/getting-started/README.md).
If you are new here, please read the getting started docs:
* [logs](./docs/logs/getting-started/README.md)
* [metrics](https://github.com/open-telemetry/opentelemetry-dotnet/blob/metrics/docs/metrics/getting-started.md)
(experimental)
* [trace](./docs/trace/getting-started/README.md)
This repository includes multiple installable components, available on
[NuGet](https://www.nuget.org/profiles/OpenTelemetry). Each component has its