This library contains open dockerized components for ROS If you wish to use ROS2 check out our ROS2 library
To participate in the contest and stand a chance to win a Leo Rover, start by forking our library. Following this, you have two options to proceed:
-
Initiate a merge request to include a folder containing your component's Dockerfile. For guidance on this, please refer to these instructions.
-
Create a merge request to add your git repository details to the
ContributedComponents.MD
file. Detailed steps can be found here.
Image | Link |
---|---|
![]() |
ROS-YDLidar-x4 |
If you wish to contribute by adding a new component to our library as part of our ongoing competition, please follow the instructions below:
Before you begin, ensure you have met the following requirements:
- Fork the Repository: Click on the 'Fork' button on the upper right-hand side of the page. A copy of the repository will be created on your personal GitHub account.
- Clone the Repository: Clone the forked repository to your local machine by running:
git clone https://github.com/cognimbus/Nimbus.Library.Components.ROS.git
comp_name
: Directory for your componentdocker
: Contains code and the Docker fileimg_file
: image represents the component
- Navigate to the cloned repository on your local machine.
- Create a new Dockerfile with the required configurations for the ROS/ROS2 application you wish to containerize.
- Test your Dockerfile locally with:
docker build -t ros_app:<tag> . docker run --rm -it ros_app:<tag>
- Place the Dockerfile and code into the appropriate directory structure within
comp_name/docker
.
- After testing, commit your changes:
git add . git commit -m "Your detailed commit message"
If you already have a git repository with a Dockerfile, simply add a link in ContributedComponents.MD and request to merge it. Make sure to add a relevant image from your git and make sure your git includes a valid Dockerfile that uses this version of ROS.
Before adding a new row to the table, make sure you have the following:
-
Image URL: The URL of the image that represents your component. This should be hosted inside your Git repository. You can obtain the URL by navigating to the image file in your Git repository (e.g., on GitHub) and copying the URL.
-
Repository URL: The URL of your Git repository where the component is hosted.
To add a new component to the table, follow these steps:
-
Open the Markdown File: Open the markdown file where the table is located.
-
Add a New Row: Add a new row to the table with the following format:
Image | Link --- | --- <img src="IMAGE_URL" alt="COMPONENT_NAME" width="40"/> | [COMPONENT_NAME](REPOSITORY_URL)
-
Replace Placeholders: Replace
IMAGE_URL
,COMPONENT_NAME
, andREPOSITORY_URL
with the actual values:IMAGE_URL
: The URL of the image you prepared in step 1.COMPONENT_NAME
: The name of your component.REPOSITORY_URL
: The URL of your Git repository.
- Push Your Changes: Push to your forked repository:
git push origin <ros-distro>
- Create a Pull Request: Navigate to your forked repository's GitHub page, click 'Pull request', and write a detailed comment.
- Submit: Click 'Submit pull request'.
If you have questions or encounter issues, open an issue in the repository, and one of our maintainers will get back to you as soon as possible. Thank you for your contribution!