GitHub フローを調べる

完了

GitHub は、プロジェクトでのコラボレーションを可能にするための最適なツールです。 GitHub フローは、GitHub 用に推奨されるブランチベースのワークフローです。

注意

GitHub フローを実装するには、GitHub アカウントとリポジトリが必要です。 「GitHub へのサインアップ」と「リポジトリを作成する」を参照してください。

ヒント

GitHub Web インターフェイス、コマンド ライン、GitHub CLI、または GitHub Desktop を使用して、GitHub フローのすべての手順を完了することができます。

最初の手順は、既定のブランチに影響を与えずに作業するためリポジトリにブランチを作成することです。コラボレーターに作業をレビューする機会を与えます。

詳細については、「リポジトリ内でブランチを作成および削除する」を参照してください。

Screenshot of a branching model representing the branch creation.

必要な変更はすべてリポジトリに対して行います。 間違えた場合は、余分な変更を元に戻すかプッシュして修正できます。

変更をコミットしてブランチにプッシュし、作業をリモート ストレージにバックアップし、コミットごとにわかりやすいメッセージを指定します。 別の方法を使用する場合に元に戻しやすくするために、各コミットには分離された完全な変更を含める必要があります。

プロジェクトで共同作業を行うすべてのユーザーが、作業内容を確認したり、質問に回答したり、提案や投稿を行ったりできます。 フィードバックを求める準備ができるまで、ブランチに対する変更の作成、コミット、プッシュを続けます。

ヒント

変更ごとに個別のブランチを作成すると、レビュー担当者がフィードバックを送信したり、自分が違いを把握したりしやすくなります。

準備ができたら、pull request を作成して、変更に関するフィードバックをコラボレーターに依頼できます。 「pull request の作成方法」を参照してください。

pull request のレビューは、コラボレーションにおける最も重要な機能の 1 つです。 変更をマージする前に、同僚とチームからの承認を要求できます。 また、変更を完了する前に早期のフィードバックやアドバイスが必要な場合に、ドラフトとしてマークすることもできます。

Screenshot of a branching model representing an open a pull request.

pull request は、提案した変更や解決している問題を含めて、可能な限り詳しく説明します。 画像、リンク、関連する問題、または情報を追加して変更内容を文書化し、レビュー担当者が各ファイルを開かなくても PR を理解しやすいようにすることができます。 「基本的な書き方とフォーマットの構文」と「pull request を issue にリンクする」を参照してください。

Screenshot of open a pull request representation with description field, related issue and a checklist template.

PR の品質とドキュメントを改善し、何かをレビュー担当者に明示的に指摘するためのもう 1 つの方法は、コメント セッション領域を使用することです。 また、@mention を行う、または特定のユーザーやチームに対してレビューを要求することもできます。

Screenshot of pull request comment field.

他の pull request 構成もあります。たとえば、pull request の作成時に特定のチームやユーザーからのレビューを自動的に要求したり、pull request での実行をチェックしたりできます。 詳細については、「ステータス チェックについて」と「保護されたブランチについて」を参照してください。

レビュー担当者のコメントとチェックの検証後は、変更をマージする準備ができたはずなので、pull request を承認できます。 「pull request をマージする」を参照してください。

競合が発生した場合は、それらを解決するよう GitHub から通知されます。 「マージ コンフリクトへの対処」。

Screenshot of a branching model representing the branch merge.

pull request のマージが成功した後は、リモート ブランチを維持する必要はありません。 ブランチを削除して、他のユーザーが誤って古いブランチを使用しないようにできます。 詳細については、「pull request 内のブランチの削除と復元」を参照してください。

注意

pull request を復元または元に戻す必要がある場合は、GitHub によってコミットとマージの履歴が保持されています。