CONTRIBUTING.md

Contributing Guide

このプロジェクトに興味を持っていただきありがとうございます。
より良いファームウェアにするため、Issue や Pull Request を歓迎します。

以下は、コントリビューションの際に守っていただきたいガイドラインです。

ブランチ戦略

本プロジェクトでは、軽量 Git-Flow を採用しています。

• main
  安定版ブランチです。ユーザーが clone してビルドする前提のため、常に動作する状態を保ちます。

• develop
  次のリリース候補をまとめるブランチです。Pull Request は基本的に develop に向けてください。

• feature/xxx
  新機能・修正用の作業ブランチです。
  コントリビューターはこの形式でブランチを作成してください。

Issue の作成

バグ報告・機能提案は Issue を作成してください。

バグ報告に含めてほしい情報

• 発生した現象
• 再現手順
• 使用した M5Stack のモデル（Basic / Core2 / Fire など）
• 使用したバージョン（タグ名 or コミットハッシュ）
• 期待される動作

機能提案に含めてほしい情報

• 追加したい機能の概要
• 目的・背景
• 既存機能との関係

Pull Request の出し方

PR の基本ルール

• マージ先は develop にしてください
• 1 PR = 1 つの目的（機能追加 / バグ修正など）
• 大きな変更は事前に Issue で相談してください
• PR テンプレートに沿って記述してください

ブランチ名の例

feature/add-oled-support fix/button-debounce refactor/sensor-driver

動作確認（M5Stack 実機テスト）

ファームウェアの性質上、実機テストは必須です。

PR には以下を記載してください：

必須項目

• 使用した M5Stack モデル
• 動作確認手順
• 既存機能への影響の有無

コーディング規約

C++ / Arduino スタイル

• インデントは 2 または 4 スペース（既存コードに合わせる）
• 関数名は camelCase
• 定数は UPPER_SNAKE_CASE
• コメントは日本語・英語どちらでも可

ファイル構成

• 新しい機能は可能な限り独立した .cpp / .h に分離してください
• 大きなクラスは 1 ファイルにまとめすぎないようにしてください

リリースフロー（メンテナー向け）

1. develop に PR を集める
2. 動作確認が完了したら develop → main にマージ
3. main にタグを付ける（例：v1.3.0）
4. GitHub Releases にリリースノートを作成