Skip to content

Commit e932947

Browse files
authored
CONTRIBUTING: add cmd to install tox on first mention of tox (#2497)
1 parent 24bd23d commit e932947

File tree

1 file changed

+14
-9
lines changed

1 file changed

+14
-9
lines changed

CONTRIBUTING.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -53,10 +53,15 @@ as well as the project's packages themselves (in `--editable` mode).
5353
You can then run `scripts/eachdist.py test` to test everything or
5454
`scripts/eachdist.py lint` to lint everything (fixing anything that is auto-fixable).
5555

56-
Additionally, this project uses [`tox`](https://tox.readthedocs.io) to automate some aspects
57-
of development, including testing against multiple Python versions.
56+
Additionally, this project uses [tox](https://tox.readthedocs.io) to automate
57+
some aspects of development, including testing against multiple Python versions.
58+
To install `tox`, run:
5859

59-
You can run:
60+
```console
61+
$ pip install tox
62+
```
63+
64+
You can run `tox` with the following arguments:
6065

6166
- `tox` to run all existing tox commands, including unit tests for all packages
6267
under multiple Python versions
@@ -88,7 +93,7 @@ with a specific git commit hash by setting an environment variable before runnin
8893
CONTRIB_REPO_SHA=dde62cebffe519c35875af6d06fae053b3be65ec tox
8994
```
9095

91-
The continuation integration overrides that environment variable with as per the configuration
96+
The continuation integration overrides that environment variable with as per the configuration
9297
[here](https://github.com/open-telemetry/opentelemetry-python/blob/9020b0baaeb41b7137badca988bb5c2d562cddee/.github/workflows/test.yml#L13).
9398

9499
### Benchmarks
@@ -125,13 +130,13 @@ pull requests (PRs).
125130

126131
To create a new PR, fork the project in GitHub and clone the upstream repo:
127132

128-
```sh
133+
```console
129134
$ git clone https://github.com/open-telemetry/opentelemetry-python.git
130135
```
131136

132137
Add your fork as an origin:
133138

134-
```sh
139+
```console
135140
$ git remote add fork https://github.com/YOUR_GITHUB_USERNAME/opentelemetry-python.git
136141
```
137142

@@ -154,7 +159,7 @@ $ git push fork feature
154159

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

157-
Pull requests are also tested for their compatibility with packages distributed
162+
Pull requests are also tested for their compatibility with packages distributed
158163
by OpenTelemetry in the [OpenTelemetry Python Contrib Repository](https://github.com/open-telemetry/opentelemetry-python.git).
159164

160165
If a pull request (PR) introduces a change that would break the compatibility of
@@ -196,7 +201,7 @@ Any Approver / Maintainer can merge the PR once it is **ready to merge**.
196201

197202
## Design Choices
198203

199-
As with other OpenTelemetry clients, opentelemetry-python follows the
204+
As with other OpenTelemetry clients, opentelemetry-python follows the
200205
[opentelemetry-specification](https://github.com/open-telemetry/opentelemetry-specification).
201206

202207
It's especially valuable to read through the [library guidelines](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/library-guidelines.md).
@@ -209,7 +214,7 @@ use cases are clear, but the method to satisfy those uses cases are not.
209214
As such, contributions should provide functionality and behavior that
210215
conforms to the specification, but the interface and structure is flexible.
211216

212-
It is preferable to have contributions follow the idioms of the language
217+
It is preferable to have contributions follow the idioms of the language
213218
rather than conform to specific API names or argument patterns in the spec.
214219

215220
For a deeper discussion, see: https://github.com/open-telemetry/opentelemetry-specification/issues/165

0 commit comments

Comments
 (0)