開発

これを読んでいるということは、Odoo のコードベースへの貢献方法に興味がある可能性が高いですね。そうであっても、偶然ここにたどり着いたとしても、大丈夫です！どちらにしても、しっかりサポートします！

関連項目

Odooに貢献する方法をほかにも見つけましょう

準備ができたら、 環境のセットアップ セクションに移動して、Odoo の開発に貢献するための旅を始めましょう。

環境のセットアップ

ここからの手順は、コードベースにローカルで変更を加えた後、GitHub にプッシュするための環境を準備するのに役立ちます。 すでにこのステップを完了している場合は、このセクションを読み飛ばして、 初めての貢献をする にアクセスしてください。

  1. まず、GitHub アカウント を作成します。 Odoo は GitHub を使用して製品のソースコードを管理します。ここで変更を加えてレビューに提出します。

  2. 新しい SSH キーを生成し、GitHub アカウント に登録します。

  3. github.com/odoo/odoo にアクセスし、右上の Fork ボタンをクリックするとあなたのアカウントにリポジトリのフォーク (your own copy) が作成されます。もし、　github.com/odoo/enterprise にアクセスできる場合は、同様にフォークを作成してください。これにより、メインのコードベースに影響を与えることなく、変更を加えられるコピーが作成されます。Odoo 社で働いている場合は、このステップをスキップしてかまいません。

  4. Git をインストール します。Git はコマンドライン（テキストベースのインターフェイス ）ツールであり、ファイルに加えられた変更履歴を記録するだけでなく、同じファイルの異なるバージョンを同時に作業できる点が大きな特長です。 つまり、他の人が保留中の作業をしていても、それを上書きする心配をせずに自分の変更作業を進めることができます。

    Git のインストールディレクトリがシステムの PATH 変数に含まれていることを確認します。

    Linux および macOS で PATH 変数を更新するためのガイド に従って、Git のインストールパス（デフォルトでは /usr/bin/git ）を追加します。

  5. あなた自身を将来の貢献者として識別するためにGitを設定します。GitHubに登録したのと同じメールアドレスを入力してください。

    $ git config --global user.name "Your Name"
$ git config --global user.email "youremail@example.com"

  6. ソースからのインストール を参照しOdooをインストールします。ソースを取得する際は、Git を使用して SSH 経由で行ってください。

  7. メインのコードベースではなく、フォークに変更をプッシュするように Git を設定します。 Odoo で作業している場合は、アカウント odoo-dev で作成された共有フォークに変更をプッシュするように Git を設定します。

    次のコマンドの <your_github_account> を、フォークを作成したあなたの GitHub アカウント名に置き換えて、実行します。

    $ cd /CommunityPath
$ git remote add dev git@github.com:<your_github_account>/odoo.git

    odoo/enterprise にアクセスできる場合は、関連するリモートも設定してください。

    $ cd /EnterprisePath
$ git remote add dev git@github.com:<your_github_account>/enterprise.git

  8. 以上です！ 初めての貢献をする への準備ができました。

初めての貢献をする

重要

  • Odooの開発は初心者には難しい場合があります。貢献する前に、小さなモジュールをコーディングするのに十分な知識があることをお勧めします。 そうでない場合は、 開発者向けチュートリアル を確認して、ギャップを埋めてください。

  • このガイドのいくつかのステップは、Gitに慣れている必要があります。 途中でつまずいた場合には、 チュートリアル や インタラクティブトレーニング が役に立ちます。

環境がセットアップされたので、コードベースへの貢献を開始できます。 ターミナルで、ソースからインストールしたOdooのディレクトリに移動し、次に挙げたガイドに従ってください。

  1. 変更を加えたいバージョンのOdooを選択します。 サポートされていないバージョンの Odoo を対象とした貢献は受け付けていません。 このガイドでは、`18.0`のブランチに対応するOdoo 18を変更することを想定しています。

  2. ブランチ 18.0 から始まる新しいブランチを作成します。ブランチ名の前に base ブランチ: 18.0-... を付けます。Odoo で作業している場合は、　18.0-...-xyz のブランチ名を末尾に付けます。

    Example

    $ git switch -c 18.0-fix-invoices

    $ git switch -c 18.0-fix-invoices-xyz

  3. まだ署名していない場合は、 Odoo CLA に署名する で署名してください。Odoo 社に勤務している方は、この手順をスキップしてください。

  4. コードベースに望ましい変更を加えます。コードベースで作業する場合は、次のルールに従ってください。

    • 変更内容に焦点を当て、具体的に注意してください。 複数の無関係な変更に同時に取り組むのではなく、ある特定の機能やバグ修正に一度に取り組むのが最善です。

    • master 以外のブランチで作業するときは、 stable policy を尊重してください。

    • コーディングガイドライン に従ってください。

    • 変更内容を十分にテストし、すべてが期待どおりに動作していること、またリグレッションや予期しない影響がないことを確認するために、 テストを書こう を参照して、テストコードを書く ようにしましょう。

  5. 変更をコミットします。 Git ガイドライン に従って、コミットメッセージを明確に書きます。

    $ git add .
$ git commit

  6. 変更をフォークにプッシュして、リモートエイリアスの dev を追加しました。

    Example

    $ git push -u dev 18.0-fix-invoices-xyz

  7. GitHub で PR を開き、変更内容をレビューに提出します。

    1. 変更対象のコードベースに応じて、odoo/odoo コードベースの 比較ページ または odoo/enterprise コードベースの 比較ページ にアクセスしてください。

    2. ベースに 18.0 を選択します。

    3. compare across forks をクリックします。

    4. Headリポジトリには <your_github_account>/odoo または <your_github_account>/enterprise を選択してください。 <your_github_account> には、フォークを作成したご自身の GitHub アカウント名を入力します。Odoo 社で作業している場合は、 odoo-dev に置き換えてください。

    5. 変更内容を確認し、 Create pull request ボタンをクリックしてください。

    6. Allow edits from maintainer チェックボックスをオンにします。Odoo で作業する場合はこの手順をスキップします。

    7. 説明を入力し、 Create pull request ボタンをもう一度クリックします。

  8. ページの下部にある統合状況を確認し、問題を解決します。

  9. PR がマージする準備ができ次第、Odooチームのメンバーが自動的にレビューに割り当てられます。 査読者に質問や発言がある場合は、それらをコメントとして投稿し、あなたには電子メールで通知されます。 これらのコメントは、貢献が進むために解決されなければなりません。

  10. 変更が承認されると、レビューはそれらを統合し、次のコードアップデート後にすべてのOdooユーザーが利用できるようになります!