opensource/opentelemetry-python-contrib
1
0
Fork 0
mirror of https://github.com/open-telemetry/opentelemetry-python-contrib.git synced 2025-07-28 12:43:39 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update CONTRIBUTING.md (#2620)

Browse Source
This commit is contained in:
Fools
2024-06-20 18:06:14 +01:00
committed by GitHub
parent 3669b477bd
commit b776ac92a8
1 changed files with 7 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
CONTRIBUTING.md
View File

@ -55,7 +55,7 @@ some aspects of development, including testing against multiple Python versions.
To install `tox`, run: To install `tox`, run:
```sh ```sh
pip install tox $ pip install tox
``` ```
You can run `tox` with the following arguments: You can run `tox` with the following arguments:
@ -128,13 +128,14 @@ pull requests (PRs).
To create a new PR, fork the project in GitHub and clone the upstream repo: To create a new PR, fork the project in GitHub and clone the upstream repo:
```sh ```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: Add your fork as an origin:
```sh ```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: Run tests:
@ -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: Check out a new branch, make modifications and push the branch to your fork:
```sh ```sh
git checkout -b feature $ git checkout -b feature
# edit files # edit files
git commit $ git commit
git push fork feature $ git push fork feature
``` ```
Open a pull request against the main `opentelemetry-python-contrib` repo. Open a pull request against the main `opentelemetry-python-contrib` repo.