cube_petit_dev_guide

CubePetit(キューブプチ)ソフトウェアの開発ガイドです。 「現在の開発者以外の人がコードベースを触れる状態にする」ことを目的に、リポジトリ構成・開発フロー・コーディング方針・テストの回し方をまとめています。

対象読者: CubePetit の ROS 2 ソフトウェアを開発・修正する sbgisen org のメンバー。

目次

ドキュメント	内容
docs/repository_map.md	どのリポジトリ・パッケージが何を担っているか(全体地図)
docs/branch_policy.md	ブランチ命名・PRフロー・ブランチ保護・CI
docs/coding_guide.md	コーディング方針(実コードの実例つき)
docs/testing.md	テストの構成と3通りの実行方法

クイックリンク

• 実機セットアップ: sbgisen/cube_petit_setup — 3ステップでロボットPCをセットアップ
• ポータルサイト: https://sbgisen.github.io/cube_petit_portal/ — CubePetit プロジェクトの入口
• ソースコード: cube_petit_ros / cube_petit_interaction / cube_petit_scenario

開発環境の前提

• Ubuntu 24.04 / ROS 2 Jazzy
• RMW: rmw_cyclonedds_cpp、ROS_DOMAIN_ID=94
• colcon ワークスペース: ~/ros(src/ 配下に約20リポジトリ)
• Python 依存の一部は uv 管理の .venv + fix_shebang.py 機構で動作(詳細は repository_map.md)

このリポジトリの更新

ドキュメントも通常のコードと同じフローで更新します(feature ブランチ → PR)。 実装と乖離した記述を見つけたら、気づいた人が直してください。