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.

Sign up for GitHub

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

Jump to bottom

add fork guidance (fix #47) #51

Merged
merged 1 commit into from
May 31, 2019
Merged

add fork guidance (fix #47) #51

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 25 additions & 4 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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+`.
Expand All @@ -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.

Expand Down