Skip to content

Commit ff17c79

Browse files
authored
Update contributing guide and remove test instructions from readme (#2632)
1 parent 3d758a9 commit ff17c79

File tree

2 files changed

+21
-15
lines changed

2 files changed

+21
-15
lines changed

CONTRIBUTING.md

Lines changed: 21 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -60,13 +60,13 @@ $ pip install tox
6060

6161
You can run `tox` with the following arguments:
6262

63-
- `tox` to run all existing tox commands, including unit tests for all packages
63+
* `tox` to run all existing tox commands, including unit tests for all packages
6464
under multiple Python versions
65-
- `tox -e docs` to regenerate the API docs
66-
- `tox -e py312-test-instrumentation-aiopg` to e.g. run the aiopg instrumentation unit tests under a specific
65+
* `tox -e docs` to regenerate the API docs
66+
* `tox -e py312-test-instrumentation-aiopg` to e.g. run the aiopg instrumentation unit tests under a specific
6767
Python version
68-
- `tox -e spellcheck` to run a spellcheck on all the code
69-
- `tox -e lint-some-package` to run lint checks on `some-package`
68+
* `tox -e spellcheck` to run a spellcheck on all the code
69+
* `tox -e lint-some-package` to run lint checks on `some-package`
7070

7171
`black` and `isort` are executed when `tox -e lint` is run. The reported errors can be tedious to fix manually.
7272
An easier way to do so is:
@@ -84,6 +84,7 @@ You can also configure it to run lint tools automatically before committing with
8484

8585
```console
8686
$ pre-commit install
87+
```
8788

8889
See
8990
[`tox.ini`](https://github.com/open-telemetry/opentelemetry-python-contrib/blob/main/tox.ini)
@@ -161,6 +162,7 @@ Open a pull request against the main `opentelemetry-python-contrib` repo.
161162

162163
* If the PR is not ready for review, please put `[WIP]` in the title, tag it
163164
as `work-in-progress`, or mark it as [`draft`](https://github.blog/2019-02-14-introducing-draft-pull-requests/).
165+
* Make sure tests and lint are passing locally before requesting a review.
164166
* Make sure CLA is signed and CI is clear.
165167

166168
### How to Get PRs Reviewed
@@ -216,13 +218,26 @@ For a deeper discussion, see: https://github.com/open-telemetry/opentelemetry-sp
216218
2. Make sure you have `tox` installed. `pip install tox`.
217219
3. Run `tox` without any arguments to run tests for all the packages. Read more about [tox](https://tox.readthedocs.io/en/latest/).
218220

221+
Some tests can be slow due to pre-steps that do dependencies installs. To help with that, you can run tox a first time, and after that run the tests using previous installed dependencies in toxdir as following:
222+
223+
1. First time run (e.g., opentelemetry-instrumentation-aiopg)
224+
```console
225+
tox -e py312-test-instrumentation-aiopg
226+
```
227+
2. Run tests again without pre-steps:
228+
```console
229+
.tox/py312-test-instrumentation-aiopg/bin/pytest instrumentation/opentelemetry-instrumentation-aiopg
230+
```
231+
219232
### Testing against a different Core repo branch/commit
220233

221234
Some of the tox targets install packages from the [OpenTelemetry Python Core Repository](https://github.com/open-telemetry/opentelemetry-python) via pip. The version of the packages installed defaults to the main branch in that repository when tox is run locally. It is possible to install packages tagged with a specific git commit hash by setting an environment variable before running tox as per the following example:
222235

236+
```sh
223237
CORE_REPO_SHA=c49ad57bfe35cfc69bfa863d74058ca9bec55fc3 tox
238+
```
224239

225-
The continuation integration overrides that environment variable with as per the configuration [here](https://github.com/open-telemetry/opentelemetry-python-contrib/blob/2518a4ac07cb62ad6587dd8f6cbb5f8663a7e179/.github/workflows/test.yml#L9).
240+
The continuous integration overrides that environment variable with as per the configuration [here](https://github.com/open-telemetry/opentelemetry-python-contrib/blob/main/.github/workflows/test.yml#L9).
226241

227242
## Style Guide
228243

README.md

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,6 @@ The Python auto-instrumentation libraries for [OpenTelemetry](https://openteleme
4646
* [Releasing](#releasing)
4747
* [Releasing a package as `1.0` stable](#releasing-a-package-as-10-stable)
4848
* [Contributing](#contributing)
49-
* [Running Tests Locally](#running-tests-locally)
5049
* [Thanks to all the people who already contributed](#thanks-to-all-the-people-who-already-contributed)
5150

5251
## Installation
@@ -143,14 +142,6 @@ Emeritus Maintainers:
143142

144143
*Find more about the maintainer role in [community repository](https://github.com/open-telemetry/community/blob/main/community-membership.md#maintainer).*
145144

146-
## Running Tests Locally
147-
148-
1. Go to your Contrib repo directory. `cd ~/git/opentelemetry-python-contrib`.
149-
2. Create a virtual env in your Contrib repo directory. `python3 -m venv my_test_venv`.
150-
3. Activate your virtual env. `source my_test_venv/bin/activate`.
151-
4. Make sure you have `tox` installed. `pip install tox`.
152-
5. Run tests for a package. (e.g. `tox -e test-instrumentation-flask`.)
153-
154145
### Thanks to all the people who already contributed
155146

156147
<a href="https://github.com/open-telemetry/opentelemetry-python-contrib/graphs/contributors">

0 commit comments

Comments
 (0)