GitHub直伝、パーフェクトなPull Requestの書き方

GitHub Logo

Pull Requestとは、開発者が作成した新機能や修正点をリポジトリの管理者に取り込んでもらうために送るリクエストのこと。

GitHubのオープンソース開発を支える技術として知られていますが、Pull Requestは人対人のやりとりなので、誤解や行き違いが発生する可能性もあります。このような不毛なやりとりを防ぐため、GitHubがパーフェクトなPull Requestを書くためのガイドラインを公開しています。

ガイドラインはPull Requestの書き方、フィードバックの返し方、フィードバックへの対応方法の3部構成となっていて、それぞれどのようなメッセージがふさわしいかの基準を示すものとなっています。

例えば、一番重要なPull Requestの書き方では以下のような書き方が望ましいとしています。

  • Pull Requestの目的を含める。
  • なぜこの作業が必要なのか(適切なリンクとともに)概要を提供する。経緯に精通していると想定しないように。
  • 会社内の誰もがPull Requestを読めることを忘れない。
  • どんなフィードバックが欲しいかを明確にする。
  • いつフィードバックが欲しいかを明確にする。
  • @mention個人は、議論に参加してほしい人とその理由を明示する。
  • @mentionチームは、議論に参加してほしいチームとその理由を明示する。

オリジナル記事にはこうやって送ったPull Requestにどうフィードバックを返すか、フィードバックが返ってきたたとき同対応するかまで説明が続いています。Pull Requestを使ったやりとりにチャレンジしてみたい方は必見のガイドだと思います。

Emoji

個人的には、絵文字の使い方まで注意書きがあるのが興味深いと思いました。

スポンサーリンク