-
Notifications
You must be signed in to change notification settings - Fork 339
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
Added README.md for dummy_map_server #572
Added README.md for dummy_map_server #572
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the PR @cardboardcode! I left a few comments. The most major thing is that the commandline blocks be modified so the information is also correct on Windows. Perhaps that means removing most of the commands and just focusing on the commands that are the same, like the ros2
and colcon
commands.
@cardboardcode, let's get these READMEs in one at a time, since you'll learn from the feedback and can apply the feedback to the other PRs, instead of me having to leave the same comment on multiple PRs. |
076cf9d
to
4d86cb1
Compare
Hi @audrow, the requested changes have been included in the latest commit for this pull request. Will need your help to review once more. Thank you. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One nitpick and then this looks good to me!
…uctions. Signed-off-by: Bey Hao Yun <[email protected]>
Decomposed sentence into smaller sizes. Co-authored-by: Audrow Nash <[email protected]> Signed-off-by: Bey Hao Yun <[email protected]>
Reworded. Co-authored-by: Audrow Nash <[email protected]> Signed-off-by: Bey Hao Yun <[email protected]>
…back. Signed-off-by: Bey Hao Yun <[email protected]>
Signed-off-by: Bey Hao Yun <[email protected]>
…atibility. Signed-off-by: Bey Hao Yun <[email protected]>
Co-authored-by: Audrow Nash <[email protected]> Signed-off-by: Bey Hao Yun <[email protected]>
f068207
to
a290e4d
Compare
@audrow, thank you for reviewing the changes. Will attempt to apply the same feedback as much as I can with other similar |
Great, you can @ me when they're ready for review! |
@cardboardcode, One small thing, if you can, avoid force pushing to your branch. It makes it so that I can't see what has changed since my last review. I understand that you may need to force push if there are conflicts. |
* ➕ 📖 Added README.md for dummy_map_server ROS2 package. Verified instructions. Signed-off-by: Bey Hao Yun <[email protected]> * Update dummy_robot/dummy_map_server/README.md Decomposed sentence into smaller sizes. Co-authored-by: Audrow Nash <[email protected]> Signed-off-by: Bey Hao Yun <[email protected]> * Update dummy_robot/dummy_map_server/README.md Reworded. Co-authored-by: Audrow Nash <[email protected]> Signed-off-by: Bey Hao Yun <[email protected]> * 🔨 Modified use of --packages-select to --packages-up-to based on feedback. Signed-off-by: Bey Hao Yun <[email protected]> * 🔨 Modified README.md further to adhere to feedback given. Signed-off-by: Bey Hao Yun <[email protected]> * 🔨 Modified README.md commands to adhere to higher cross-platform compatibility. Signed-off-by: Bey Hao Yun <[email protected]> * Update dummy_robot/dummy_map_server/README.md Co-authored-by: Audrow Nash <[email protected]> Signed-off-by: Bey Hao Yun <[email protected]> Signed-off-by: Bey Hao Yun <[email protected]> Co-authored-by: Audrow Nash <[email protected]>
* ➕ 📖 Added README.md for dummy_map_server ROS2 package. Verified instructions. Signed-off-by: Bey Hao Yun <[email protected]> * Update dummy_robot/dummy_map_server/README.md Decomposed sentence into smaller sizes. Co-authored-by: Audrow Nash <[email protected]> Signed-off-by: Bey Hao Yun <[email protected]> * Update dummy_robot/dummy_map_server/README.md Reworded. Co-authored-by: Audrow Nash <[email protected]> Signed-off-by: Bey Hao Yun <[email protected]> * 🔨 Modified use of --packages-select to --packages-up-to based on feedback. Signed-off-by: Bey Hao Yun <[email protected]> * 🔨 Modified README.md further to adhere to feedback given. Signed-off-by: Bey Hao Yun <[email protected]> * 🔨 Modified README.md commands to adhere to higher cross-platform compatibility. Signed-off-by: Bey Hao Yun <[email protected]> * Update dummy_robot/dummy_map_server/README.md Co-authored-by: Audrow Nash <[email protected]> Signed-off-by: Bey Hao Yun <[email protected]> Signed-off-by: Bey Hao Yun <[email protected]> Co-authored-by: Audrow Nash <[email protected]> Signed-off-by: Bey Hao Yun <[email protected]>
Purpose of Pull Request
This pull request adds a
README.md
to dummy_map_server as part of efforts to address the issue highlighted in #531.