Welcome to Chassis contributing guide

このプロジェクトのバージョニングは Semantic versioning に従っている。

コミットメッセージは Conventional commit に従っている。

ブランチ戦略は GitHub Flow を取っている。

Unit Test には Google Test を使用している。

Documentation には Doxygen と GitHub Pages を使用している。

Quick Start

Issues

ドキュメントの不備
不具合を見つけた場合
新機能の要望

はじめにIssueが既に存在するかを検索し、関連するIssueが存在しなかった場合に新しいIssueを作成すること。

Make Changes

Docker, vscode をインストールする。
ページ上部の Open in Dev Containers またはこちらを押す。
任意の変更を行う。
scripts/test.bash を実行してコードのテストを行う。
```
scripts/test.bash
```
scripts/deploy.bash を実行すると、 Doxygen によるドキュメントの生成が行われる。 http://localhost:8000 より WEB ページの出力が確認できる。
```
scripts/deploy.bash
```

Library Manager

このライブラリは Arduino Library Manager に登録されており、logはここから確認できる。

Platform IOのレジストリにも登録されている。

CI/CD

開発者の環境

Ubuntu 22.04
VSCode + Platform IO
Git + Github