Skip to content

Commit 02550ad

Browse files
committed
update the guide
Signed-off-by: emdneto <[email protected]>
1 parent 98166c6 commit 02550ad

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -280,14 +280,15 @@ Below is a checklist of things to be mindful of when implementing a new instrume
280280

281281
### Update supported instrumentation package versions
282282

283-
- Update the respective instrumentation `pyproject.toml` file in _instruments_ entry under `[project.optional-dependencies]` section
284-
- Update instrumentation `package.py` file in `_instruments` variable
285-
- Run command `tox -e generate` to regenerate necessary files
283+
- Navigate to the **instrumentation package directory:**
284+
- Update the respective instrumentation **`pyproject.toml`** file by modifying _instruments_ entry in the [project.optional-dependencies] section with the new version constraint
285+
- Update instrumentation **`package.py`** file in `_instruments` variable with the new version constraint
286+
- At the **root of the project directory**, run `tox -e generate` to regenerate necessary files
286287

287288
If you're adding support for a new version of the instrumentation package, follow these additional steps:
288289

289-
- Add new test-requirements.txt file with the respective package version required for testing
290-
- Add a new test environment entry for the package version in `tox.ini` and run `tox -e generate-workflows` to generate new workflows
290+
- At the **instrumentation package directory:** Add new test-requirements.txt file with the respective package version required for testing
291+
- At the **root of the project directory**: Add a new test environment entry for the package version in [tox.ini](./tox.ini) and run `tox -e generate-workflows` to regenerate new workflows accordingly. At the same file, search for `opentelemetry-instrumentation-{package}/test-requirements` and add a new line to point to the new test-requirements.txt you created in the previous step so tox can install the correct requirements.
291292

292293
Example PRs: [#2976](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/2976), [#2845](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/2845)
293294

0 commit comments

Comments
 (0)