コードレビューのための GitHub プルリクエスト

WordPress の開発では SVN を使用していますが、多くの貢献者は GitHub を使用して Git で作業することを好んでいます。多くの貢献者は、継続的インテグレーションやインラインコードコメントなどの機能を使用できるように、公式の WordPress 開発用ミラーをフォークしてプルリクエストを作成しています。

Trac に実験的な機能が追加され、公式の WordPress 開発用 Git ミラーに対して開かれた GitHub のプルリクエストをチケットにリンクできるようになりました。これにより、GitHub での貢献が、関連する Trac チケットにおいてより直接的に表示されるようになり、2つのリポジトリ間でのコラボレーションが容易になります。

備考: GitHub 上のプルリクエストはマージされません。 コードの変更は、コミット権限が付与された信頼できる長期的な貢献者によって、SVN リポジトリに行われる必要があります。

GitHub

  • GitHub で、公式の WordPress 開発用ミラーをフォークします。
  • フォークにブランチを作成し、変更を加え、コミットし、プッシュします。
  • プルリクエストを wordpress-develop に対して作成し、プルリクエスト本文に Trac チケットの完全な URL を記述してください。例: See https://core.trac.wordpress.org/ticket/49295
  • コラボレーションを容易にするために、「Allow edits and access to secrets by maintainers」に必ずチェックを入れてください。これにより、WordPress コアのコミッターがあなたのフォーク上のブランチに、より大きな変更案を直接プッシュできます。

Top ↑

Trac

  • プルリクエストは、チケットの添付ファイル欄の下に、以下の内容で表示されます。
    • 変更された行の数
    • プルリクエストのチェック状況 (Draft/Closed、Travis CI、コンフリクトの発生など)
    • プルリクエストを見るためのボタン
    • 差分を見るためのボタン
  • チケットのイベントのタイムラインに、そのチケットがいつどこで言及されたかを示すボットコメントが追加されます。
  • プルリクエストがコメントを受け取るたびに、プルリクエストのボットがそのコメントを Trac チケットに投稿します。
A screenshot of a WordPress Core Trac ticket with the new linked Pull Requests between the ticket attachments and comments.
プルリクエストは、添付ファイルと変更履歴の間に表示されます。

Top ↑

重要事項

プルリクエストのボットがコメントを Trac に同期するとき、Trac チケットを購読している人にはメールは送信されません。 この理由から、Trac 自身で何らかのチケットの更新することが推奨されます。ほとんどの場合、キーワードを更新する必要があるでしょう (has-patch や needs-testing を追加するなど)。

プルリクエストのコードレビュー中に作成されたインラインコメントは、Trac チケットには投稿されません。 これらのコメントは、プルリクエストの特定の状態 (コミット) における特定の行に関連するもので、ブランチのコードが更新されるにつれて不自然な印象を与えるでしょう。

GitHub 上のプルリクエストは監視されません。 新しいプルリクエストを定期的にチェックする人はいないでしょう。WordPress コアに含めることを検討するために、プルリクエストは Trac チケットに添付されなければなりません。

時々、自分自身の作業を整理してください。 今のところ、プルリクエストは関連する Trac チケットが解決されたときに自動的にクローズされるわけではありません。もしあなたがプルリクエストを開いたら、コアにマージされたプルリクエストを可能な限り閉じるようにしましょう。

そして最後に、これは実験です。これは最初のバージョンですので、おそらく小さなバグや改善点があるでしょう。何か問題を見つけた場合は、Meta トラックでチケットを作成してください。すべてのフィードバックを歓迎します !

原文 / 日本語訳

最終更新日: