diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8d76f49..05c9d5e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -23,7 +23,7 @@ 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/synchros2/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/synchros2/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: @@ -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/synchros2/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/synchros2/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/synchros2/issues/new). +- Open an [issue](https://github.com/rai-opensource/synchros2/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/synchros2/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/synchros2/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/synchros2/issues). +Feature requests are tracked as [GitHub issues](https://github.com/rai-opensource/synchros2/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 ae637e1..5282d1a 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,22 @@ # Repository Migration Notice > [!IMPORTANT] -> This repository is moving to the **RAI-Opensource** GitHub organization in **about 2 weeks from April 9, 2026 (UTC)**. +> This repository has moved to the **RAI-Opensource** GitHub organization! > -> Current status: **pre-migration**. -> Migration target org: +> Current status: **Migrated**. +> +> - Migration target org: +> - Previous target org: > > What to do now: > -> - Watch this repository for the final cutover update and destination repository link. -> - Plan to update your git remote after the move: +> - Update your git remote: > > ```bash -> git remote set-url origin +> git remote set-url origin https://github.com/RAI-Opensource/synchros2 > ``` > -> - If you maintain downstream docs/scripts, prepare to update links from this repository to the new org. +> - If you maintain downstream docs/scripts, update links from this repository to the new org. > # `synchros2` diff --git a/synchros2/docs/concepts/message_feeds.md b/synchros2/docs/concepts/message_feeds.md index cca29cf..111cdba 100644 --- a/synchros2/docs/concepts/message_feeds.md +++ b/synchros2/docs/concepts/message_feeds.md @@ -12,7 +12,7 @@ Any message filter can become a feed, allowing: Like message filters, most message feeds can be chained. This is true for all but those that externally source messages, ROS 2 topic subscriptions being the prime example. These are sources only. Other message feeds built into `synchros2` offer a vehicle for generic map-filter-reduce patterns, time synchronization across multiple message feeds, and synchronized `tf` lookups. -**Note:** While any message filter can become a feed, standard ROS 2 message filters are usually not thread-safe. See [`synchros2.filters`](https://github.com/bdaiinstitute/synchros2/tree/main/synchros2/synchros2/filters.py) for thread-safe (re)implementations. +**Note:** While any message filter can become a feed, standard ROS 2 message filters are usually not thread-safe. See [`synchros2.filters`](https://github.com/rai-opensource/synchros2/tree/main/synchros2/synchros2/filters.py) for thread-safe (re)implementations. ## Looping over topic messages diff --git a/synchros2/docs/getting_started/installation.md b/synchros2/docs/getting_started/installation.md index c99b6a9..d2a1a95 100644 --- a/synchros2/docs/getting_started/installation.md +++ b/synchros2/docs/getting_started/installation.md @@ -28,7 +28,7 @@ sudo apt install ros-$ROS_DISTRO-synchros2 ```bash mkdir -p path/to/workspace/src # for a new workspace cd path/to/workspace/src - git clone https://github.com/bdaiinstitute/synchros2.git + git clone https://github.com/rai-opensource/synchros2.git ``` 2. Install `synchros2` dependencies with `rosdep`: