From c5829af56a8854a9203e43045b7eb8a2ba766c70 Mon Sep 17 00:00:00 2001 From: Jenny Barry Date: Tue, 28 Apr 2026 09:12:27 -0400 Subject: [PATCH 1/2] Update for migration to new org --- CONTRIBUTING.md | 12 ++++++------ README.md | 17 +++++++++++++++++ proto2ros/README.md | 4 ++-- 3 files changed, 25 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 648cb54..442a411 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -23,11 +23,11 @@ All types of contributions are encouraged and valued. See the [Table of Contents ## I Have a Question -Before you ask a question, it is best to search for existing [issues](https://github.com/bdaiinstitute/proto2ros/issues) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first. +Before you ask a question, it is best to search for existing [issues](https://github.com/rai-opensource/proto2ros/issues) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first. If you then still feel the need to ask a question and need clarification, we recommend the following: -- Open an [issue](https://github.com/bdaiinstitute/proto2ros/issues/new). +- Open an [issue](https://github.com/rai-opensource/proto2ros/issues/new). - Provide as much context as you can about what you're running into. - Provide project and platform versions (nodejs, npm, etc), depending on what seems relevant. @@ -47,7 +47,7 @@ A good bug report shouldn't leave others needing to chase you up for more inform - Make sure that you are using the latest version. - Determine if your bug is really a bug and not an error on your side. If you are looking for support, you might want to check [this section](#i-have-a-question)). -- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](https://github.com/bdaiinstitute/proto2ros/issues?q=label%3Abug). +- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](https://github.com/rai-opensource/proto2ros/issues?q=label%3Abug). - Collect information about the bug: - Stack trace (Traceback) - OS, ROS, Platform and Version (Windows, Linux, macOS, x86, ARM) @@ -60,7 +60,7 @@ A good bug report shouldn't leave others needing to chase you up for more inform We use GitHub issues to track bugs and errors. If you run into an issue with the project: -- Open an [issue](https://github.com/bdaiinstitute/proto2ros/issues/new). +- Open an [issue](https://github.com/rai-opensource/proto2ros/issues/new). - Explain the behavior you would expect and the actual behavior. - Please provide as much context as possible and describe the *reproduction steps* that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case. - Provide the information you collected in the previous section. @@ -78,13 +78,13 @@ Once it's filed: - Make sure that you are using the latest version. - Read the documentation carefully and ensure the functionality is indeed missing. -- Perform a [search](https://github.com/bdaiinstitute/proto2ros/issues) to see if the feature has already been requested. If it has, add a comment to the existing issue instead of opening a new one. +- Perform a [search](https://github.com/rai-opensource/proto2ros/issues) to see if the feature has already been requested. If it has, add a comment to the existing issue instead of opening a new one. - Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library. #### How Do I Submit a Good Feature Request? -Feature requests are tracked as [GitHub issues](https://github.com/bdaiinstitute/proto2ros/issues). +Feature requests are tracked as [GitHub issues](https://github.com/rai-opensource/proto2ros/issues). - Use a **clear and descriptive title** for the issue to identify the suggestion. - Provide a **step-by-step description of the suggested enhancement** in as many details as possible. diff --git a/README.md b/README.md index 52ae0ae..43382c2 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,23 @@ ![Python Support](https://img.shields.io/badge/python-3.8%20%7C%203.9%20%7C%203.10%20%7C%203.11%20%7C%203.12-blue) ![ROS Support](https://img.shields.io/badge/ROS-humble%20%7C%20jazzy-blue) +# Repository Migration Notice + +> [!IMPORTANT] +> This repository has moved to the **RAI-Opensource** GitHub organization! +> +> Current status: **Migrated**. +> - Migration target org: https://github.com/RAI-Opensource +> - Previous target org: https://github.com/bdaiinstitute +> +> What to do now: +> - Update your git remote: +> ```bash +> git remote set-url origin https://github.com/RAI-Opensource/spot_ros2 +> ``` +> - If you maintain downstream docs/scripts, update links from this repository to the new org. + + ## Overview `proto2ros` helps maintain an interoperability layer between Protobuf dependent and ROS 2 aware code by generating equivalent ROS 2 message definitions given source Protobuf message definitions, as well bi-directional conversion APIs in relevant languages such as C++ and Python. To date, Protobuf syntax versions 2 and 3 are supported but only syntax version 3 has been extensively tested. diff --git a/proto2ros/README.md b/proto2ros/README.md index bb62a5f..e4c6718 100644 --- a/proto2ros/README.md +++ b/proto2ros/README.md @@ -711,7 +711,7 @@ ament_export_targets(${PROJECT_NAME}) ament_package() ``` -__NOTE__: proto3 optional fields require the `--experimental_allow_proto3_optional` flag for protobuf versions 3.12-3.14. `proto2ros_generate()` handles this automatically. However, if you use `protobuf_generate()` directly in your own code, note that it does not support passing this flag in CMake < 3.28. See [`proto2ros_tests`](https://github.com/bdaiinstitute/proto2ros/tree/main/proto2ros_tests) for an example of calling `protoc` directly as a workaround. +__NOTE__: proto3 optional fields require the `--experimental_allow_proto3_optional` flag for protobuf versions 3.12-3.14. `proto2ros_generate()` handles this automatically. However, if you use `protobuf_generate()` directly in your own code, note that it does not support passing this flag in CMake < 3.28. See [`proto2ros_tests`](https://github.com/rai-opensource/proto2ros/tree/main/proto2ros_tests) for an example of calling `protoc` directly as a workaround. ### ROS 2 vendored Protobuf messages @@ -748,4 +748,4 @@ proto2ros_vendor_package(${PROJECT_NAME} ament_package() ``` -[`bosdyn_msgs`](https://github.com/bdaiinstitute/bosdyn_msgs) is a good example of this. +[`bosdyn_msgs`](https://github.com/rai-opensource/bosdyn_msgs) is a good example of this. From f28446aa4e025610a77b233bbbb03e5b53af50b6 Mon Sep 17 00:00:00 2001 From: Jenny Barry <116907872+jbarry-bdai@users.noreply.github.com> Date: Tue, 28 Apr 2026 15:55:16 -0400 Subject: [PATCH 2/2] Apply suggestion from @tcappellari-bdai Co-authored-by: Tiffany Cappellari <156013635+tcappellari-bdai@users.noreply.github.com> Signed-off-by: Jenny Barry <116907872+jbarry-bdai@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 43382c2..3a20a36 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ > What to do now: > - Update your git remote: > ```bash -> git remote set-url origin https://github.com/RAI-Opensource/spot_ros2 +> git remote set-url origin https://github.com/RAI-Opensource/proto2ros > ``` > - If you maintain downstream docs/scripts, update links from this repository to the new org.