オープンな自動車ソフトウェアプラットフォームへの入り口。

コントリビューションガイド

このページは、個人および組織がEclipse SDVエコシステムへの参加をスムーズに始めるためのガイドです。コミュニティの運営方法、ドキュメントの入手先、プロジェクトへの貢献方法、そしてワーキンググループや技術的な議論への参加方法など、必要な情報を提供しています。 エンジニア、戦略担当者、意思決定者など、あらゆる立場の方々が、自動車ソフトウェアの未来を形作るオープンテクノロジープラットフォームへの参加を自信を持って進められるよう支援します。

はじめ方

01.

Eclipseアカウントを作成する

clipse Foundationのプロジェクトに参加するには、まずEclipseアカウントを作成してください。このアカウントを利用することで、課題管理システム(Issue Tracking)、メーリングリスト、そしてコントリビューター契約(Contributor Agreement)などの各種サービスにアクセスできるようになります。 また、GitHubアカウントとの連携も必ず行ってください。連携されていない場合、提出されたコントリビューションをマージすることができません。

02.

Eclipse Contributor Agreement(ECA)に署名する

Eclipseプロジェクトへコントリビューションを提出する前に、Eclipse Contributor Agreement(ECA)への署名が必要です。

詳細情報および契約書は、こちらからご確認いただけます。https://www.eclipse.org/legal/eca/ https://www.eclipse.org/legal/eca/

ECAは、コントリビューションを行うために必要な権利を保有していることを確認するとともに、そのコントリビューションがプロジェクトのライセンス条件に適合していることを保証するためのものです。

03.

SDVプロジェクトを探る

Eclipse SDVのすべてのプロジェクトはこちらからご覧いただけます。 http://sdv.eclipse.org/projects/

Top Level Project Automotiveもぜひご覧ください。https://projects.eclipse.org/
projects/automotive

Eclipse Foundationのすべてのプロジェクトをご覧になりたい方は、こちらをご参照ください。 https://projects.eclipse.org/

First issues & best practices

プロジェクトでは、「good first issue」「help wanted」「beginner」などのラベルを使って、初めてのコントリビューター向けの課題を案内していることがあります。自分のスキルや興味に合った課題を見つけたら、その課題に取り組むことをメンテナーに知らせるため、コメントを投稿しましょう。

こちらは、Eclipse ThreadXにおける実際の事例です。 https://github.com/orgs/eclipse-threadx/projects/2/views/2?filterQuery=label%3A%22good
+first+issue%22


以下は、Eclipse Ankaiosの実際の課題例です。 https://github.com/orgs/eclipse-ankaios/projects/1/views/10 

First Issues & Best Practices

Projects often tag beginner-friendly tasks with labels such as good first issue, help wanted, or beginner.  Pick an issue that fits your skills or interests, then leave a comment to let project maintainers know you’re working on it.


こちらは、Eclipse ThreadXにおける実際の事例です。 https://github.com/orgs/eclipse-threadx/projects/2/views/2?filterQuery=label%3A%22good+first+issue%22
以下は、Eclipse Ankaiosの実際の課題例です。 https://github.com/orgs/eclipse-ankaios/projects/1/views/10 

Contribution workflow

これはオープンソース開発における一般的なコントリビューションの流れですが、プロジェクトごとに貢献ルールが異なる場合があります。コントリビューションを行う際は、必ず対象プロジェクトの CONTRIBUTING.md ファイルを確認してください。

重要: ECA(Eclipse Contributor Agreement)は、Eclipseアカウントのユーザー情報に基づいて確認されます。必ずGitHubアカウントをEclipseアカウントに連携してください。連携されていない場合、プロジェクトのCIパイプラインによる検証に失敗します。 以下は、プロジェクトのコントリビューションガイドの実例です。 Eclipse Ankaios コントリビューションガイド: https://github.com/eclipse-ankaios/ankaios/blob/main/CONTRIBUTING.md

1.

リポジトリをフォークし、フォークしたリポジトリをローカル環境にクローンしてください。

2.

変更内容に対応するフィーチャーブランチを作成してください。

3.

プロジェクトのコーディング規約に従い、品質が高く十分にテストされたコードを作成してください。

4.

変更内容が分かる説明的なコミットメッセージを作成してください。

5.

作成したブランチをフォーク先のリポジトリへプッシュしてください。

6.

プロジェクトのメインリポジトリに対してプルリクエスト(PR)を作成してください。

7.

レビューに対応し、必要に応じて修正や更新を行ってください。

ベストプラクティス

  • プルリクエスト(PR)は小さく、目的を明確に保ちましょう。1つのPRでは1つの論理的な変更に集中することを推奨します。
  • 分かりやすいドキュメントやコメントを作成しましょう。
  • プロジェクトのコーディングスタイルやガイドラインに従ってください。
  • コードレビューでは、迅速かつ敬意を持って対応しましょう。
  • 不明な点がある場合は早めに質問してください。円滑なコミュニケーションが成功の鍵です。
  • コントリビューションの取り扱いについて理解するために、ハンドブックの法務/知的財産(IP)に関するセクションを確認してください。(ハンドブックの「IP/Project Content」セクションをご参照ください。) Eclipse Foundation Handbook

これらのステップを実践することで、Eclipseオープンソースエコシステムの一員として活躍する準備が整います。コミュニティへのご参加を歓迎します!

プロジェクトの組織構成、リポジトリ構造、および利用ツール

すべての Eclipse Foundation プロジェクトは、GitHub 上でそれぞれ独立した Organization として管理されています。
GitLab でも同様の構成となっています。すべての GitHub Organization は Otterdog によって管理・設定されています。
各プロジェクトとそのステータスの一覧は、Otterdog ダッシュボードから確認できます:https://otterdog.eclipse.org/index

リポジトリ構成

プロジェクトごとに多少の違いはありますが、多くのEclipseプロジェクトのリポジトリは共通した構成になっています。

  • README.md — 概要と利用開始手順
  • CONTRIBUTING.md — コントリビューションガイド
  • /src — ソースコード
  • /docs — プロジェクトのドキュメント
  • /tests — 自動テスト
  • /examples — サンプルコード・設定例

利用するツール

  • Git / GitHub — バージョン管理・コードレビュー
  • Issue Tracker — バグ・改善要望の管理
  • ビルドツール — Maven、Gradle、Tycho など
  • CI/CDシステム — GitHub Actions、Jenkins など
  • IDE / エディター — Eclipse IDE、VS Code など

開発環境のセットアップ

コントリビューションを始める前に、プロジェクトのセットアップガイドに従って必要な依存関係をインストールし、プロジェクトをインポートしたうえで、ローカル環境でビルドおよびテストを実行してください。あわせて、READMEやプロジェクトのWebサイトもよく確認しましょう。
You can find an example here: こちらで例をご覧いただけます。