Skip to content

Commit 3bd60e2

Browse files
committed
[chore] Removed $ from command for contribution guidance
The copy in markdown file always copy the $ as well when copying the command, I need to remove the $ manually each time.
1 parent cc62d1f commit 3bd60e2

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

CONTRIBUTING.md

Lines changed: 11 additions & 11 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
@@ -124,31 +124,31 @@ pull requests (PRs).
124124
To create a new PR, fork the project in GitHub and clone the upstream repo:
125125

126126
```sh
127-
$ git clone https://github.com/open-telemetry/opentelemetry-python-contrib.git
128-
$ cd opentelemetry-python-contrib
127+
git clone https://github.com/open-telemetry/opentelemetry-python-contrib.git
128+
cd opentelemetry-python-contrib
129129
```
130130

131131
Add your fork as an origin:
132132

133133
```sh
134-
$ git remote add fork https://github.com/YOUR_GITHUB_USERNAME/opentelemetry-python-contrib.git
134+
git remote add fork https://github.com/YOUR_GITHUB_USERNAME/opentelemetry-python-contrib.git
135135
```
136136

137137
Run tests:
138138

139139
```sh
140140
# make sure you have all supported versions of Python installed
141-
$ pip install tox # only first time.
142-
$ tox # execute in the root of the repository
141+
pip install tox # only first time.
142+
tox # execute in the root of the repository
143143
```
144144

145145
Check out a new branch, make modifications and push the branch to your fork:
146146

147147
```sh
148-
$ git checkout -b feature
148+
git checkout -b feature
149149
# edit files
150-
$ git commit
151-
$ git push fork feature
150+
git commit
151+
git push fork feature
152152
```
153153

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

0 commit comments

Comments
 (0)