プルリクエスト
ローカル環境のセットアップ
ステップ1: フォーク
GitHub でプロジェクトをフォークし、ローカルでフォークをクローンします。
$ git clone git@github.com:username/electron.git
$ cd electron
$ git remote add upstream https://github.com/electron/electron.git
$ git fetch upstream
ステップ2: ビルド
ビルド手順と依存関係は、オペレーティングシステムによっ て若干異なります。 Electron をローカルに構築する際は、これらの詳細なガイドを参照してください。
プロジェクトをローカルに構築したら、変更を始める準備が整います!
ステップ3: ブランチ
開発環境を整理しておくために、作業を支えるローカルのブランチを作りましょう。 これらは、main
ブランチから直接分岐する必要があります。
$ git checkout -b my-branch -t upstream/main
変更を加える
ステップ4: コーディング
electron/electron
リポジトリに対して開かれたほとんどのプルリクエストには、shell/
フォルダの C/C++ コード、lib/
フォルダの JavaScript コード、docs/api/
のドキュメント、spec/
フォルダのテストの変更が含まれます。
コードの変更時に npm run lint
を実行して、プロジェクトのコードスタイルに従うようにしてください。
プロジェクトのさまざまな部分でコードを変更する際のベストプラクティスの詳細については、コーディングスタイル を参照してください。
ステップ5: コミット
変更を個々のコミット内で論理的にグループ化しておくことを推奨します。 コントリビューターの多くが、複数のコミットに分割された変更をより簡単に確認できます。 プルリクエストのコミット数に制限はありません。
$ git add my/changed/files
$ git commit
複数のコミットは、取り込み時にスカッシュされることに注意してください。
コミットメッセージのガイドライン
良いコミットメッセージは、何が何故変更されたのか、が記述されるべきです。 このElectronプロジェクトはセマンティックコミットメッセージをつかって、このリリースプロセスを合理化しています。
プルリクエストがマージされるためには、プルリクエストにタイトルがあり、それには意図を示すプレフィックスがなければなりません
意図を示すプレフィックスのあるコミットメッセージのの例です。:
fix: don't overwrite prevent_default if default wasn't prevented
feat: add app.isPackaged() method
docs: app.isDefaultProtocolClient is now available on Linux
プレフィックスの例:
- fix: バグ修正
- feat: 新機能
- docs: ドキュメントの変更
- test: 足りないテストの追加や既存のテストの訂正
- build: ビルドシステムに影響する変更
- ci: CI の設定ファイルとスクリプトへの変更
- perf: パフォーマンスを改善するコード変更
- refactor: バグ修正や機能追加の無いコード変更
- style: コードの意味を変えない変更 (lint)
その他、コミットメッセージを作成するときに留意すること:
- 最初の行は、以下の通りにしてください。
- 変更の簡単な説明を含める (50 文字以下が好ましく、72 文字を超えない)
- 適切な名詞、頭字語、および関数/変数名のようなコードを参照する単語を除いて、完全な小文字にする
- 2行目は空にしてください。
- 他のすべての行は72列で折り返します。