Language: Japanese, English (Google Translation)
CHIRIMEN Drivers へのコントリビュート方法です。
このリポジトリは、CHIRIMEN で使う IoT デバイスドライバをまとめた monorepo（複数パッケージを一つのリポジトリで管理する構成）です。60 個以上のセンサーやモジュール用ドライバが packages/ 以下にあり、それぞれが npm パッケージ（@chirimen/デバイス名）として公開されています。
このガイドの読み方: やりたいことに合わせて、下のフローチャートと目次から該当するガイドを選んでください。初めての方は 初めての貢献 から始めることをおすすめします。
やりたいことに応じて、読むべきガイドが決まります。Git を使う作業はいったん 開発環境のセットアップ を経てから、それぞれの手順ガイドに進みます。
Issue #464 でも整理されている通り、実務上は I2C デバイスドライバ追加だけでなく、サンプル単体・デバイス単体でのコントリビューションもあり得ます。ただし現時点では、これら単体向けのコントリビューションガイドは本リポジトリ側に整備されていません。
flowchart TD
start[貢献を始める] --> choose{やりたいことは?}
choose -->|誤字・文言修正| docUI["初めての貢献（GitHub UI）"]
choose -->|ドキュメント修正 Git使用| docGit["初めての貢献（Git）"]
choose -->|既存ドライバ修正| fixDriver["既存ドライバの修正"]
choose -->|新ドライバ追加| addDriver["新しいドライバの追加"]
choose -->|npm公開・リリース| releaseGuide["リリース方法"]
docUI --> commonPR["Pull Requestを作成"]
docGit --> setupGuide["開発環境のセットアップ"]
fixDriver --> setupGuide
addDriver --> setupGuide
setupGuide --> commonPR
| フローチャートの項目 | ガイド |
|---|---|
| 初めての貢献（GitHub UI） | 初めての貢献 の「方法 A」 |
| 初めての貢献（Git） | 開発環境のセットアップ → 初めての貢献 の「方法 B」 |
| 既存ドライバの修正 | 開発環境のセットアップ → 既存ドライバの修正 |
| 新しいドライバの追加 | 開発環境のセットアップ → 新しいドライバの追加 |
| リリース方法 | リリース方法（メンテナ向け） |
| Pull Request を作成 | 各ガイドの最終ステップ。PR の基本ルールは はじめに・基本ルール を参照 |
| やりたいこと | ガイド | 難易度 |
|---|---|---|
| 環境構築・Git の基本 | 開発環境のセットアップ | 初級 |
| ドキュメント修正 | 初めての貢献 | 初級 |
| 既存ドライバの修正 | 既存ドライバの修正 | 中級 |
| 新しいドライバの追加 | 新しいドライバの追加 | 中級〜上級 |
PR が master にマージされると、GitHub Actions が自動的に npm へパッケージを公開します。手動でリリース作業を行う必要はありません。
バージョン管理の仕組みやメンテナ向けの詳細は リリース方法 を参照してください。