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

  • 6 分

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

変更について説明する

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

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

メッセージの本文と pull request では、引き続き現在時制を使用します。変更の動機を含めるようにします。 必ず、変更の動機を含めるようにします。 変更を前の行動と比較します。 自由に使えるスペースを使用して、"方法" に対する "対象" と "理由" を説明します。

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

細分性を追加する

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

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

  • バグ (赤): 機能していないものがあります
  • ドキュメント (青): ドキュメントへの改善または追加
  • 重複 (グレー): このイシューまたは pull request は既に存在します
  • 拡張機能 (ティール): 新しい機能または要求

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

  • サブスクライブしない: 参加している場合または @mentioned された場合にのみ、通知を受け取ります
  • サブスクライブ済み: この pull request に関するすべての通知を受け取ります
  • カスタム: 選択したイベントに関する通知のみを受け取ります

演習

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

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

ボーナス: Microsoft のアクセシビリティのガイドラインと要件をご確認ください。 特に、UI の対話に関する情報を参照して、貢献で障碍者を差別するような表現を使用しないようにします。 ユーザーは、さまざまな入力方法を使用して製品を操作します。 たとえば、キーボード、マウス、タッチ、音声などを使用できます。 どのような入力方法にも通用する汎用的な動詞を使用します。 たとえば、入力固有の "クリックする" や "スワイプする" ではなく "選択" を使用します。