Skip to content

Commit 09c65b1

Browse files
committed
make contributing commands copyable
Signed-off-by: emdneto <[email protected]>
1 parent 95de9f4 commit 09c65b1

File tree

1 file changed

+25
-11
lines changed

1 file changed

+25
-11
lines changed

CONTRIBUTING.md

Lines changed: 25 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -170,31 +170,45 @@ pull requests (PRs).
170170
To create a new PR, fork the project in GitHub and clone the upstream repo:
171171

172172
```console
173-
$ git clone https://github.com/open-telemetry/opentelemetry-python.git
174-
$ cd opentelemetry-python
173+
git clone https://github.com/open-telemetry/opentelemetry-python.git
174+
cd opentelemetry-python
175175
```
176176

177177
Add your fork as an origin:
178178

179179
```console
180-
$ git remote add fork https://github.com/YOUR_GITHUB_USERNAME/opentelemetry-python.git
180+
git remote add fork https://github.com/YOUR_GITHUB_USERNAME/opentelemetry-python.git
181181
```
182182

183-
Run tests:
183+
Make sure you have all supported versions of Python installed, install tox only for the first time:
184184

185185
```sh
186-
# make sure you have all supported versions of Python installed
187-
$ pip install tox # only first time.
188-
$ tox # execute in the root of the repository
186+
pip install tox
187+
```
188+
189+
Run tests in the root of the repository (this will run all tox environments and may take some time):
190+
191+
```sh
192+
tox
189193
```
190194

191195
Check out a new branch, make modifications and push the branch to your fork:
192196

193197
```sh
194-
$ git checkout -b feature
195-
# edit files
196-
$ git commit
197-
$ git push fork feature
198+
git checkout -b feature
199+
```
200+
201+
After you edit the files, stage changes in the current directory:
202+
203+
```sh
204+
git add .
205+
```
206+
207+
Then run the following to commit the changes:
208+
209+
```sh
210+
git commit
211+
git push fork feature
198212
```
199213

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

0 commit comments

Comments
 (0)