Skip to content

Commit 98166c6

Browse files
committed
contributing: add guidance for update package versions support
Signed-off-by: emdneto <[email protected]>
1 parent ecf5529 commit 98166c6

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

CONTRIBUTING.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -278,6 +278,19 @@ Below is a checklist of things to be mindful of when implementing a new instrume
278278
- Testing
279279
- When adding a new instrumentation remember to update `tox.ini` adding appropriate rules in `envlist`, `command_pre` and `commands` sections
280280

281+
### Update supported instrumentation package versions
282+
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
286+
287+
If you're adding support for a new version of the instrumentation package, follow these additional steps:
288+
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
291+
292+
Example PRs: [#2976](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/2976), [#2845](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/2845)
293+
281294
## Guideline for GenAI instrumentations
282295

283296
Instrumentations that relate to [Generative AI](https://opentelemetry.io/docs/specs/semconv/gen-ai/) systems will be placed in the [instrumentation-genai](./instrumentation-genai) folder. This section covers contributions related to those instrumentations. Please note that the [guidelines for instrumentations](#guideline-for-instrumentations) and [expectations from contributors](#expectations-from-contributors) still apply.

0 commit comments

Comments
 (0)