Skip to content

Commit 0671966

Browse files
authored
Update CONTRIBUTING.md
1 parent 02550ad commit 0671966

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -281,14 +281,14 @@ Below is a checklist of things to be mindful of when implementing a new instrume
281281
### Update supported instrumentation package versions
282282

283283
- 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
284+
- Update the respective instrumentation **`pyproject.toml`** file by modifying _instruments_ entry in the `[project.optional-dependencies]` section with the new version constraint
285285
- Update instrumentation **`package.py`** file in `_instruments` variable with the new version constraint
286286
- At the **root of the project directory**, run `tox -e generate` to regenerate necessary files
287287

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

290290
- 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.
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. In the same [tox.ini](./tox.ini) 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.
292292

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

0 commit comments

Comments
 (0)