Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add CARMA Platform System ROS1/ROS2 Status Documentation #379

Merged
merged 9 commits into from
Sep 12, 2024

Conversation

MishkaMN
Copy link
Contributor

@MishkaMN MishkaMN commented Aug 21, 2024

PR Details

Description

The README has been updated to include a description of the current breakdown/overview of ROS 1 Noetic and ROS 2 Foxy content existing within the CARMA Platform System. This documentation is being included to help new developers avoid confusion when inspecting the CARMA Platform system's codebase and stumbling across a small amount of ROS 1 Noetic packages in different repositories.

This documentation will be updated as ROS 1 Noetic packages continue to be ported to ROS 2 Foxy, and again when packages are upgraded from ROS 2 Foxy to ROS 2 Humble.

Related Issue

ARC-147 Jira ticket.

Motivation and Context

See above.

How Has This Been Tested?

NA

Types of changes

  • Defect fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature that cause existing functionality to change)

Checklist:

  • I have added any new packages to the sonar-scanner.properties file
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
    CARMA Contributing Guide
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@MishkaMN MishkaMN added documentation Improvements or additions to documentation enhancement New feature or request labels Aug 21, 2024
@MishkaMN MishkaMN requested a review from JonSmet August 21, 2024 18:53
@JonSmet JonSmet changed the title add ROS1/ROS2 component documentation Add CARMA Platform System ROS1/ROS2 Status Documentation Sep 5, 2024
@JonSmet JonSmet requested review from saina-ramyar and adev4a and removed request for JonSmet September 5, 2024 17:54
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@JonSmet JonSmet merged commit 705ae1c into develop Sep 12, 2024
@JonSmet JonSmet deleted the arc-147-ros1-ros2-doc branch September 12, 2024 20:58
This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants