ros2 / ros2/examples

improve names of executables and mention them in the readme

Open
#160 7 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
C++
Stars
970
Forks
365
Avg merge
12d 20h
Merged PRs (30d)
1

Description

Currently the names are only discoverable by using the shell completion if you know that they start with examples_rclcpp_minimal_. They are not mentioned anywhere in the README files.

Also why having the suffix _main for examples_rclcpp_minimal_client_main?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the README files and the executable names exposed through shell completion, including examples_rclcpp_minimal_client_main. Inventory the current names and decide which naming changes are in scope. Done means the executable names are consistent and all relevant executables are mentioned in the README files.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
build-system, documentation
Issue type
Refactor
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.