Skip to content

Commit

Permalink
Include dummy version upload as part of contributing process to mitig…
Browse files Browse the repository at this point in the history
…ate namespace issues

As discussed in the 07/25 SIG, we will begin releasing dummy versions of new packages immediately after the corresponding PR has been merged to mitigate name-squatting incidents.

Also included an excerpt in CONTRIBUTING.md to confirm whether namespaces have already been taken before the addition of new packages.
  • Loading branch information
lzchen authored Jul 26, 2024
1 parent c45a620 commit 77797c9
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -250,7 +250,8 @@ The continuous integration overrides that environment variable with as per the c
Below is a checklist of things to be mindful of when implementing a new instrumentation or working on a specific instrumentation. It is one of our goals as a community to keep the implementation specific details of instrumentations as similar across the board as possible for ease of testing and feature parity. It is also good to abstract as much common functionality as possible.

- Follow semantic conventions
- The instrumentation should follow the semantic conventions defined [here](https://github.com/open-telemetry/opentelemetry-specification/tree/main/specification/semantic-conventions.md)
- The instrumentation should follow the semantic conventions defined [here](https://github.com/open-telemetry/semantic-conventions/tree/main/docs)
- Contains a name that is not already claimed in [Pypi](https://pypi.org/)
- Extends from [BaseInstrumentor](https://github.com/open-telemetry/opentelemetry-python-contrib/blob/2518a4ac07cb62ad6587dd8f6cbb5f8663a7e179/opentelemetry-instrumentation/src/opentelemetry/instrumentation/instrumentor.py#L35)
- Supports auto-instrumentation
- Add an entry point (ex. <https://github.com/open-telemetry/opentelemetry-python-contrib/blob/2518a4ac07cb62ad6587dd8f6cbb5f8663a7e179/instrumentation/opentelemetry-instrumentation-requests/pyproject.toml#L44>)
Expand Down

0 comments on commit 77797c9

Please sign in to comment.