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

Restructure the examples as an individual packages #119

Closed
bailaC opened this issue Jun 28, 2021 · 2 comments
Closed

Restructure the examples as an individual packages #119

bailaC opened this issue Jun 28, 2021 · 2 comments

Comments

@bailaC
Copy link
Contributor

bailaC commented Jun 28, 2021

Hello All,

while working with examples, I found it would be better if we

  1. Keep individual examples complete in itself.
  2. Each example should contain the proper folder structure
  3. While merging any Pull Request, it MUST have the Readme file, which MUST include below points but not limited to,
  • How to run the example (Detailed step)
  • Expected command output (if any)
  • Expected simulation output (rviz, Gazebo etc. if any)

The basic idea behind all the above points is,

  1. Any example can be tried independently.
  2. All the required files/folders will be inside a "Single" folder. Users need not to concern about any other files/folders.
  3. Maintenance will be much cleaner.

These are just my thoughts. Just want to make life easier for the Beginners. Please feel free to add your thoughts.

@bailaC
Copy link
Contributor Author

bailaC commented Jul 13, 2021

I also propose to have Readme files for each example in their respective folder. So that the ros2_control_demos Readme file stays clean.

Any thoughts @destogl , @bmagyar , @olivier-stasse

@destogl
Copy link
Member

destogl commented Feb 2, 2023

Everything is placed into #231

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants