Skip to content

Commit

Permalink
CONTRIBUTING: add cmd to install tox on first mention of tox (#2497)
Browse files Browse the repository at this point in the history
  • Loading branch information
chalin authored Mar 3, 2022
1 parent 24bd23d commit e932947
Showing 1 changed file with 14 additions and 9 deletions.
23 changes: 14 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,10 +53,15 @@ as well as the project's packages themselves (in `--editable` mode).
You can then run `scripts/eachdist.py test` to test everything or
`scripts/eachdist.py lint` to lint everything (fixing anything that is auto-fixable).

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

You can run:
```console
$ pip install tox
```

You can run `tox` with the following arguments:

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

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

### Benchmarks
Expand Down Expand Up @@ -125,13 +130,13 @@ pull requests (PRs).

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

```sh
```console
$ git clone https://github.com/open-telemetry/opentelemetry-python.git
```

Add your fork as an origin:

```sh
```console
$ git remote add fork https://github.com/YOUR_GITHUB_USERNAME/opentelemetry-python.git
```

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

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

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

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

## Design Choices

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

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

It is preferable to have contributions follow the idioms of the language
It is preferable to have contributions follow the idioms of the language
rather than conform to specific API names or argument patterns in the spec.

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

0 comments on commit e932947

Please sign in to comment.