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

add fork guidance (fix #47) (#51)

This commit is contained in:
Austin Parker 2019-05-31 11:13:43 -04:00 committed by GitHub
parent e9c1015c79
commit 97c4ad9f01
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 25 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
CONTRIBUTING.md
View File

@ -2,7 +2,7 @@
## Report a bug or requesting feature
Reporting bug is an important contribution. Please make sure to include:
Reporting bugs is an important contribution. Please make sure to include:
- expected and actual behavior.
- dotnet version that application is compiled on and running with (it may be
@ -13,15 +13,36 @@ Reporting bug is an important contribution. Please make sure to include:
## How to contribute
### Before started
### Before you start
Please read project contribution
[guide](https://github.com/open-telemetry/community/blob/master/CONTRIBUTING.md)
for general practices for OpenTelemetry project.
### Fork
In the interest of keeping this repository clean and manageable, you should work from a fork. To create a fork, click the 'Fork' button at the top of the repository, then clone the fork locally using `git clone git@github.com:USERNAME/opentelemetry-dotnet.git`.
You should also add this repository as an "upstream" repo to your local copy, in order to keep it up to date. You can add this as a remote like so:
```
git remote add upstream https://github.com/open-telemetry/opentelemetry-dotnet.git
#verify that the upstream exists
git remote -v
```
To update your fork, fetch the upstream repo's branches and commits, then merge your master with upstream's master:
```
git fetch upstream
git checkout master
git merge upstream/master
```
Remember to always work in a branch of your local copy, as you might otherwise have to contend with conflicts in master.
### Build
You can use Visual Studio 2017+ or VS code to contribute. Just open root folder
You can use Visual Studio 2017+ or VS Code to contribute. Just open root folder
or `OpenTelemetry.sln` in your editor and follow normal development process.
To build from command line you need `dotnet` version `2.0+`.
@ -32,7 +53,7 @@ dotnet build OpenTelemetry.sln
### Test
You can use Visual Studio 2017 or VS code to test your contribution. Open root
You can use Visual Studio 2017 or VS Code to test your contribution. Open root
folder or `OpenTelemetry.sln` in your editor and follow normal development
process.