Skip to content

Commit 5989497

Browse files
gyliu513lzchenxrmx
authored
[chore] Removed $ from command for contribution guidance (#3114)
The copy in markdown file always copy the $ as well when copying the command, I need to remove the $ manually each time. Co-authored-by: Leighton Chen <[email protected]> Co-authored-by: Riccardo Magliocchetti <[email protected]>
1 parent 77708cd commit 5989497

File tree

1 file changed

+28
-14
lines changed

1 file changed

+28
-14
lines changed

CONTRIBUTING.md

Lines changed: 28 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ some aspects of development, including testing against multiple Python versions.
5656
To install `tox`, run:
5757

5858
```sh
59-
$ pip install tox
59+
pip install tox
6060
```
6161

6262
You can run `tox` with the following arguments:
@@ -74,13 +74,13 @@ You can run `tox` with the following arguments:
7474
`ruff check` and `ruff format` are executed when `tox -e ruff` is run. We strongly recommend you to configure [pre-commit](https://pre-commit.com/) locally to run `ruff` automatically before each commit by installing it as git hooks. You just need to [install pre-commit](https://pre-commit.com/#install) in your environment:
7575

7676
```console
77-
$ pip install pre-commit -c dev-requirements.txt
77+
pip install pre-commit -c dev-requirements.txt
7878
```
7979

8080
and run this command inside the git repository:
8181

8282
```console
83-
$ pre-commit install
83+
pre-commit install
8484
```
8585

8686
See
@@ -126,31 +126,45 @@ pull requests (PRs).
126126
To create a new PR, fork the project in GitHub and clone the upstream repo:
127127

128128
```sh
129-
$ git clone https://github.com/open-telemetry/opentelemetry-python-contrib.git
130-
$ cd opentelemetry-python-contrib
129+
git clone https://github.com/open-telemetry/opentelemetry-python-contrib.git
130+
cd opentelemetry-python-contrib
131131
```
132132

133133
Add your fork as an origin:
134134

135135
```sh
136-
$ git remote add fork https://github.com/YOUR_GITHUB_USERNAME/opentelemetry-python-contrib.git
136+
git remote add fork https://github.com/YOUR_GITHUB_USERNAME/opentelemetry-python-contrib.git
137137
```
138138

139-
Run tests:
139+
make sure you have all supported versions of Python installed, install `tox` only for the first time:
140140

141141
```sh
142-
# make sure you have all supported versions of Python installed
143-
$ pip install tox # only first time.
144-
$ tox # execute in the root of the repository
142+
pip install tox
143+
```
144+
145+
Run tests in the root of the repository (this will run all tox environments and may take some time):
146+
147+
```sh
148+
tox
145149
```
146150

147151
Check out a new branch, make modifications and push the branch to your fork:
148152

149153
```sh
150-
$ git checkout -b feature
151-
# edit files
152-
$ git commit
153-
$ git push fork feature
154+
git checkout -b feature
155+
```
156+
157+
After you edit the files, stage changes in the current directory:
158+
159+
```sh
160+
git add .
161+
```
162+
163+
Then run the following to commit the changes:
164+
165+
```sh
166+
git commit
167+
git push fork feature
154168
```
155169

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

0 commit comments

Comments
 (0)