Developer Guidelines

2024-04-24: The content on this has been preserved while we work to revise the content

For up-to-date information about the meta-ros layer please visit the main page: https://github.com/ros/meta-ros

For simplified instructions on how to get started please refer to these build instructions: https://github.com/ros/meta-ros/blob/build/kas/README.md

To chat about meta-ros, come find us on the OSRF Discord #cwg-openembedded channel.

You are also welcome to join our biweekly meetings. Catch up on our meeting minutes here: ROS OpenEmbedded Working Group Minutes - Google Docs

Development rules

• Source-code centric: Use of github features

• Style of Commits: OpenEmbedded style

• Open Resources: Issue tracker and Wiki is open for everybody's use.

• Style of Commit Messages:

  • It starts with the name of the recipe/directory.
  • Then it describes the patch on an abstract level (not the concrete change, because that's visible in the patch itself). We use the present progressive form, e.g., 'adding', 'removing', 'adjusting'.
  • It avoids the word 'fix', because commonly, 'fixes' do break scenarios where people have relied on its previous behavior, even if it was quite strange.
  • We refer to the addressed issue usually in brackets with 'resolves'

Communication channels

• Mailing list
• Commits, github comments, github issues
• github Wiki