diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 5c2663a133232..ea640aefded3e 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -25,7 +25,8 @@ Distro packaging links: ## Links to Distribution Packages - + - Debian: https://packages.debian.org/ - REQUIRED diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index abe95bae01e96..ffdd51a4b6fec 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -124,6 +124,9 @@ TODO If the ebuild you are referencing is not in either of those locations, please file a PR into ROS-Overlay to add it and any needed dependencies to the tree. +Note that `pip` cannot be used to install system packages on Gentoo. +If the package is not present in the Gentoo package repository, please create an issue on the https://github.com/ros/ros-overlay repository so that it may be created at a later date, omit the key from the new rosdep rule, and link the created issue in the PR which is adding the rule. [Here's a simple example](https://github.com/ros/ros-overlay/issues/1019). + #### Arch Linux Packages must be in the official Archlinux core, extra, or community repositories at the time they are contributed. @@ -216,6 +219,9 @@ Some existing rules do not have `python-` or `python3-` prefixes, but this is no 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. +As a reminder `pip` rules should not be used on Gentoo. +See above for the Gentoo specific guidelines. + How to submit pull requests ---------------------------