search

SSL-Roots / consai2r2

https://github.com/SSL-Roots/consai_ros2 へ開発を移行しています。
MIT License
8 stars 7 forks source link

meet the ament_cpplint format #19

Closed MiraiHattori closed 4 years ago

MiraiHattori commented 4 years ago

ament_cpplintコマンドを実行しつつ，すべてのlintエラーを消してみたので共有させていただきます．

ソースコード内で勝手にRootsさんの名前をお借りして私の名前でcommitしたりしているので，PRはmergeせずにcloseして参考程度にしていただくのがよいかもしれないです．

特筆すべきこととしては，ament_cpplintを実行した時に No copyright message found. You should have a line: "Copyright [year] " [legal/copyright] と言われたのでファイルの先頭にCopyright (c) 2019 SSL-Rootsと入れたり Missing username in TODO; it should look like "// TODO(my_username): Stuff." [readability/todo] と言われ，TODOの後に(SSL-Roots)と入れたり Found C system header after other header. Should be: joystick_component.h, c system, c++ system, other. [build/include_order] と言われincludeの順番を変えたり， At least two spaces is best between code and comments [whitespace/comments] と言われスペースを追加したり，

ifndef header guard has wrong style, please use: CONSAI2R2_TELEOP__VISIBILITY_CONTROLH

とパッケージの名前を先頭に入れたりしました． [追記] Include the directory when naming .h files [build/include] と言われていたので，visibility_control.hをvisibility_control.hppにrenameしました

ShotaAk commented 4 years ago

ありがとうございます！参考になります！ せっかくなのでマージしたいのですが、今回は参考のみにさせてください。 （めっちゃマージしたいプルリクです！）