演習 - 最初の pull request を作成する

  • 6 分

pull request テンプレートまたは CONTRIBUTING ファイルでガイダンスが提供されている場合に pull request (PR) を作成する方法を学習しました。 しかし、プロジェクトでそのようなガイダンスや、規則に関するドキュメントが提供されていない場合はどうなるでしょうか?

変更について説明する

適切なコミット メッセージとその後の pull request を作成するには、次のプラクティスに従います。

  • Git コミット メッセージの件名には、次の文を完全に記述する必要があります:
    • "If applied, this commit <your subject line here>" (適用された場合、このコミットは <ご自分の件名>)。
  • 命令形の現在時制を使用して変更を簡潔に説明します。 たとえば、add を使用し、added や adds は使用しないでください。
  • 件名を 50 文字以下に制限します。
  • 先頭を大文字にし、末尾にはピリオド (.) を付けないようにします。
  • 絵文字や他の GitHub ユーザー @mention 件名行で使用できますが、すべてのプロジェクトでこれを許可または推奨するわけではないことに注意してください。

メッセージの本文と pull request では、引き続き現在時制を使用します。変更の動機を含めるようにします。 必ず、変更の動機を含めるようにします。 変更を前の行動と比較します。 自由に使えるスペースを活用して、何となぜをどのように説明するのかを明確にしてください。

コミット メッセージは、送信しようとしている内容の要点のみにします。 レビューのために、変更を小さなセットに分離してコミットおよび送信します。 このプラクティスに従うことにより、変更がプロジェクトにマージされる可能性が高くなります。

細分性を追加する

pull request を送信する前に、サイド バーで PR を完了する方法を確認してください。 プロジェクトのチーム構造に慣れている場合は、[ レビュー担当者 ] または [ 担当者] を選択します。 たとえば、CONTRIBUTING.md ファイルでのラベルの使用に関するガイダンス がある場合は 、ラベルを追加します。 ラベルは、実行しようとしている内容に関する視覚的な手掛かりとして使用できます。 保守管理者も、1 つまたは複数のラベルを追加する可能性があります。

ヒント

リポジトリに CONTRIBUTING.md ファイルまたは PR テンプレートがある場合は、pull request を入力するときにガイダンスに従ってください。

この Learn モジュール用のリポジトリでは、次のようなラベルを使用します。

  • バグ (赤): 何かが機能していません
  • ドキュメント (青): ドキュメントの機能強化または追加
  • 重複 (灰色): この問題または pull request は既に存在します
  • 機能強化 (ティール): 新機能または要求

必要に応じて、サイドバーで 問題をリンク できます。pull request を正常にマージすると、対応する問題が閉じる可能性があります。 スレッド上の 通知 にサブスクリプションをカスタマイズすることもできます。 PR によっては、多数のコメント、レビュー、CI/CD 関連の通知を受け取る場合があります。 次の項目から選択できます。

  • サブスクライブされていません: 参加した場合、または@mentionedに選ばれた場合にのみ通知を受け取る
  • 購読： この pull request のすべての通知を受信する
  • 習慣： 選択したイベントについてのみ通知を受け取る

演習

First Contributions プロジェクトを使用して、プル要求のフォーク、複製、送信を練習します。 First Contributions プロジェクトは、"初心者が最初の貢献を行う方法をガイドする" ことを目的としており、コマンド ラインおよび複数のグラフィカル ユーザー インターフェイス (GUI) を使用するためのガイドが用意されています。 また、このプロジェクトでは複数の言語がサポートされています。 Translations フォルダーを必ずご確認ください。

前のユニットで学んだ内容と前述の点を念頭に置いて、最近開いた pull request に戻ります。 または、注視しているプロジェクトの pull request のタブに移動することもできます。 適切な件名によってどのような効果があるかを確認します。 それに応じて pull request を更新することを検討します。 プロジェクトを変更したときと同じくらいの時間をかけて PR を作成します。 保守管理者が、コミュニティの貢献を分類し、優先度付け (トリアージ) を行うことができるようにします。

ボーナス： Microsoft のアクセシビリティ ガイドラインと要件を確認します。 特に、投稿で差別的な表現を避けるためには、UIとの対話を記述する方法に関する情報を参照してください。 ユーザーは、さまざまな入力方法を使用して製品を操作します。 たとえば、キーボード、マウス、タッチ、音声などを使用できます。 どのような入力方法にも通用する汎用的な動詞を使用します。 たとえば、入力固有のクリックまたはスワイプの代わりに select を使用します。