Merge pull request #70 from SSL-Roots/update_contributing

Add an explanation about format check in CONTRIBUTING.md

Author: nabekuro0104

CONTRIBUTING.md

@@ -29,9 +29,36 @@ issueの内容については制限を設けていません。
 [ROS 2 Developer Guide](https://index.ros.org/doc/ros2/Contributing/Developer-Guide/)
 に従います。
 
-将来的にはlintを使ってチェックする予定です。
+ファイルのフォーマットは
+[ament_lint](https://github.com/ament/ament_lint)
+によってビルド時にチェックされます。
+
+ローカルでフォーマットをチェックする場合は次のコマンドを実行します。
+
+```sh
+$ cd ~/ros2_ws
+$ colcon test
+# テストの結果を表示
+$ colcon test-result --verbose
+```
+
+また、次のようにファイルを個別にチェックすることも可能です。
+
+```sh
+# C++のコードはament_uncrustifyやament_clang_formatによってフォーマットをチェックできます
+$ cd ~/ros2_ws/src/consai2r2
+# チェック結果を表示
+$ ament_uncrustify consai2r2_teleop/src/joystick_component.cpp           
+# フォーマットを修正（ファイルの中身が書き換わります）
+$ ament_uncrustify --reformat consai2r2_teleop/src/joystick_component.cpp
+```
+
+`consai2r2`のホームディレクトリには[clang-formatの設定ファイル](./.clang-format)を用意しています。
+clang-formatコマンドや、エディタのフォーマッタ設定等に活用してください。
+
+`.clang-format`ファイルを使用しても`colcon test`に失敗する場合があります。
+**[GitHub Actions](https://github.com/SSL-Roots/consai2r2/actions)でのテストが通るように修正してください。**
 
-その他の細かいルールが決まり次第、本ファイルに追記します。
 
 ## その他