From 9d14f1533dd8fe7aa332a9d2a9ce165d624ed899 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Steven!=20Ragnar=C3=B6k?= Date: Mon, 26 Sep 2022 15:16:56 -0700 Subject: [PATCH 1/2] Start drafting requirements for inclusion in this metapackage. Mostly we want to set the expectation that most extensions won't be included in the common extensions metapackage. --- README.rst | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.rst b/README.rst index 9c45d5d..8b25b26 100644 --- a/README.rst +++ b/README.rst @@ -2,3 +2,20 @@ colcon-common-extensions ======================== A meta package aggregating `colcon-core `_ as well as a set of common extensions. + +Requirements for inclusion +-------------------------- + +As colcon's ecosystem continues to grow, the number of extensions which could possibly be considered "common" grows as well. +There are no set criteria for inclusion in this metapackage but we try to set some minimum expectations and recommendations. +Ultimately, inclusion in this metapackage will be at the discretion of the colcon core maintainers. +Removing extensions from this metapackage presents an extreme challenge since removing any package from the set of common extensions is likely to impact workflows for colcon users. +Since removal will be so difficult we must also be extremely discerning about packages that are added. + + * Included extensions must be hosted under the `colcon organization `_ on GitHub. + * The colcon core maintainers must have the capability to make package releases through PyPI and the colcon apt repositories in the event that bugfix releases are needed and the extension's original maintainers have moved on. + * Colcon is heavily used by the `ROS `_ and `Gazebo `_ communities. + Adding a package to colcon-common-extensions must not adversely affect ROS 2 CI builds or Gazebo CI as ROS 2 and the ROS and Gazebo community represent a significant portion of colcon's users. + * Packages added should depend on a minimal number of modules outside the Python standard library. + Any package which provides features that are available using just the Python standard library must be justified. + In order to be part of colcon-common-extensions, Python package dependencies must be available in Debian Unstable and should be available in the latest Ubuntu LTS release and in the current EPEL release. From ddcedfac185cf18a84b3e196567cb48761fa8069 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Steven!=20Ragnar=C3=B6k?= Date: Mon, 26 Sep 2022 15:27:17 -0700 Subject: [PATCH 2/2] Formatting. --- README.rst | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.rst b/README.rst index 8b25b26..2e0005f 100644 --- a/README.rst +++ b/README.rst @@ -12,10 +12,10 @@ Ultimately, inclusion in this metapackage will be at the discretion of the colco Removing extensions from this metapackage presents an extreme challenge since removing any package from the set of common extensions is likely to impact workflows for colcon users. Since removal will be so difficult we must also be extremely discerning about packages that are added. - * Included extensions must be hosted under the `colcon organization `_ on GitHub. - * The colcon core maintainers must have the capability to make package releases through PyPI and the colcon apt repositories in the event that bugfix releases are needed and the extension's original maintainers have moved on. - * Colcon is heavily used by the `ROS `_ and `Gazebo `_ communities. - Adding a package to colcon-common-extensions must not adversely affect ROS 2 CI builds or Gazebo CI as ROS 2 and the ROS and Gazebo community represent a significant portion of colcon's users. - * Packages added should depend on a minimal number of modules outside the Python standard library. - Any package which provides features that are available using just the Python standard library must be justified. - In order to be part of colcon-common-extensions, Python package dependencies must be available in Debian Unstable and should be available in the latest Ubuntu LTS release and in the current EPEL release. +* Included extensions must be hosted under the `colcon organization `_ on GitHub. +* The colcon core maintainers must have the capability to make package releases through PyPI and the colcon apt repositories in the event that bugfix releases are needed and the extension's original maintainers have moved on. +* Colcon is heavily used by the `ROS `_ and `Gazebo `_ communities. + Adding a package to colcon-common-extensions must not adversely affect ROS 2 CI builds or Gazebo CI as ROS 2 and the ROS and Gazebo community represent a significant portion of colcon's users. +* Packages added should depend on a minimal number of modules outside the Python standard library. + Any package which provides features that are available using just the Python standard library must be justified. + In order to be part of colcon-common-extensions, Python package dependencies must be available in Debian Unstable and should be available in the latest Ubuntu LTS release and in the current EPEL release.