Skip to content

Commit f639606

Browse files
authored
Include dummy version upload as part of contributing process to mitigate namespace issues (#4087)
1 parent a9628b2 commit f639606

File tree

2 files changed

+8
-0
lines changed

2 files changed

+8
-0
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -284,3 +284,7 @@ When adding support for a new Python release remember to:
284284
- Update github workflows accordingly; lint and benchmarks use the latest supported version
285285
- Update `.pre-commit-config.yaml`
286286
- Update tox examples in the documentation
287+
288+
## Contributions that involve new packages
289+
290+
As part of an effort to mitigate namespace squatting on Pypi, please ensure to check whether a package name has been taken already on Pypi before contributing a new package. Contact a maintainer, bring the issue up in the weekly Python SIG or create a ticket in Pypi if a desired name has already been taken.

RELEASING.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,10 @@
8888
https://readthedocs.org/projects/opentelemetry-python/builds/.
8989
If the build has not run automatically, it can be manually trigger via the readthedocs interface.
9090

91+
## Releasing dev version of new packages to claim namespace
92+
93+
When a contribution introduces a new package, in order to mitigate name-squatting incidents, release the current development version of the new package under the `opentelemetry` user to simply claim the namespace. This should be done shortly after the PR that introduced this package has been merged into `main`.
94+
9195
## Troubleshooting
9296

9397
### Publish failed

0 commit comments

Comments
 (0)