diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 048a9daa6c..1a7e58cf1f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -284,3 +284,7 @@ When adding support for a new Python release remember to: - Update github workflows accordingly; lint and benchmarks use the latest supported version - Update `.pre-commit-config.yaml` - Update tox examples in the documentation + +## Contributions that involve new packages + +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. diff --git a/RELEASING.md b/RELEASING.md index e324621634..09e23ba357 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -88,6 +88,10 @@ https://readthedocs.org/projects/opentelemetry-python/builds/. If the build has not run automatically, it can be manually trigger via the readthedocs interface. +## Releasing dev version of new packages to claim namespace + +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`. + ## Troubleshooting ### Publish failed