Require python3- prefix with PyPI keys (ros#25508)

* Don't recommend python*- prefix with PyPI keeys Discussion ros#25474 (comment) ros#23836 (comment) * Move sentence to it's not confused with example. * Require python3- prefix Signed-off-by: Shane Loretz <[email protected]> * Update CONTRIBUTING.md Signed-off-by: Shane Loretz <[email protected]> Co-authored-by: Chris Lalancette <[email protected]> * When -> when Signed-off-by: Shane Loretz <[email protected]> Co-authored-by: Jacob Perron <[email protected]> Co-authored-by: Chris Lalancette <[email protected]> Co-authored-by: Jacob Perron <[email protected]>
movefasta · Aug 13, 2020 · f01a0ca · f01a0ca
1 parent 2c46208
commit f01a0ca
Showing 1 changed file with 6 additions and 6 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -148,21 +148,21 @@ Additionally, if you rely on a dependency that uses `_python3`-suffixed codename
 
 #### pip
 
-Python packages, which are only available on pip, should use the `-pip` extension. Also the `python-`/`python3-` prefix needs to be used.
+Python packages, which are only available on [PyPI](https://pypi.org/), should use the prefix `python3-` and suffix `-pip` to avoid colliding with future keys from package managers.
+
 For example:
 
 ```yaml
-python-foobar-pip:
- ubuntu:
- pip:
- packages: [foobar]
-...
 python3-foobar-pip:
  ubuntu:
  pip:
  packages: [foobar]
 ```
 
+Some existing rules do not have `python-` or `python3-` prefixes, but this is no longer recommended.
+If the package ever becomes available in Debian or Ubuntu, the `python3-` prefix ensures that the `pip` key is next to it alphabetically.
+The `-pip` key should be removed when the package becomes available on all platforms, and all existing users of the `-pip` key should migrate to the new key.
+
 How to submit pull requests
 ---------------------------