chirimen-drivers

はじめに・基本ルール

貢献の種類と手順の選び方

CONTRIBUTING.md のフローチャート で全体の流れを確認できます。やりたいことに合わせて、読むべきガイドを選んでください。

なお、Issue #464 でも触れられている通り、実務上は I2C デバイスドライバに限らず、サンプル単体・デバイス単体でのコントリビューションもあり得ますが、これら単体向けのガイドは現時点では未整備です。

やりたいこと 読むガイド 難易度
誤字・文言の修正(Git 不要) 初めての貢献 の GitHub UI 編集 初級
ドキュメント修正(Git 使用) セットアップ初めての貢献 初級
既存ドライバのバグ修正・機能追加 セットアップ既存ドライバの修正 中級
新しいドライバの追加 セットアップ新しいドライバの追加 中級〜上級
npm への公開・リリース(メンテナ向け) リリース方法 上級

初めてコントリビュートする方は、まず小さなドキュメント修正から Pull Request を送ると、フォーク・ブランチ・PR の流れを体験できます。

行動規範

コントリビューター行動規範 - Contributor Covenant

行動規範に反するコントリビュートは受け入れません。

Issues と Pull Request

Issues

質問、バグ、提案、その他 Issue を歓迎します。

Pull Request

ドキュメント追加、モジュール追加、バグ修正、その他改善するための Pull Request を歓迎します。

PR を送るときの基本ルール:

詳細は セットアップ の「共通の Git ワークフロー」を参照してください。

← 目次に戻る