Skip to content

Commit

Permalink
Update CONTRIBUTING.md (#2620)
Browse files Browse the repository at this point in the history
  • Loading branch information
zhihali authored Jun 20, 2024
1 parent 3669b47 commit b776ac9
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ some aspects of development, including testing against multiple Python versions.
To install `tox`, run:

```sh
pip install tox
$ pip install tox
```

You can run `tox` with the following arguments:
Expand Down Expand Up @@ -128,13 +128,14 @@ pull requests (PRs).
To create a new PR, fork the project in GitHub and clone the upstream repo:

```sh
git clone https://github.com/open-telemetry/opentelemetry-python-contrib.git
$ git clone https://github.com/open-telemetry/opentelemetry-python-contrib.git
$ cd opentelemetry-python-contrib
```

Add your fork as an origin:

```sh
git remote add fork https://github.com/YOUR_GITHUB_USERNAME/opentelemetry-python-contrib.git
$ git remote add fork https://github.com/YOUR_GITHUB_USERNAME/opentelemetry-python-contrib.git
```

Run tests:
Expand All @@ -148,10 +149,10 @@ $ tox # execute in the root of the repository
Check out a new branch, make modifications and push the branch to your fork:

```sh
git checkout -b feature
$ git checkout -b feature
# edit files
git commit
git push fork feature
$ git commit
$ git push fork feature
```

Open a pull request against the main `opentelemetry-python-contrib` repo.
Expand Down

0 comments on commit b776ac9

Please sign in to comment.