Draft PR とプルリクエストテンプレート
早い段階でフィードバックを得るための draft pull requests と、GitHub への貢献内容を標準化する PR templates の使い方を学びます。
「Draft PR とプルリクエストテンプレート」はCoddyKit上の無料DevOps Bootcampレッスンです。 これはレッスン4/4です。 下記で完全なレッスンを無料で読むことができます。その後、ブラウザ内の組み込みコードエディタと24時間対応のAIチューターでハンズオン演習できます。 これはDevOps Bootcamp学習パスの一部であり、ウェブとCoddyKitアプリ全体で進捗が同期されます。 DevOps Bootcampコースには全4レッスンが含まれています。
ドラフトプルリクエストとは
ドラフトプルリクエストは、作業がまだ進行中であることを示します。準備完了としてマークするまでマージできませんが、早い段階で共有してフィードバックを集めることができます。
ドラフトを使う理由
ドラフトは次のような場合に便利です。
- 完成前に方向性を示す
- 早い段階でCIを実行する
- 正式なレビューを依頼せずに質問する
GitHubでのドラフトPRの作成
新しいプルリクエストのページで、緑色のボタンの横にあるドロップダウンをクリックし、ドラフトプルリクエストを作成を選択します。
CLIからのドラフト作成
GitHub CLIを使うと、ドラフトを直接作成できます。
gh pr create --draft --title 'WIP: new search' --body 'Early work'レビュー準備完了への変更
作業が完了したら、PRをレビュー準備完了としてマークします。これによりレビュアーに通知され、マージできるようになります。
gh pr readyPRテンプレートとは
プルリクエストテンプレートは、チェックリストやセクションを使ってPRの説明をあらかじめ入力し、コントリビューターが必要な情報を含められるようにします。
テンプレートの保存場所
GitHubは、リポジトリ内の.github/pull_request_template.mdにテンプレートがあるかを確認します。
テンプレートの作成
テンプレートは、すべてのPRに含めたいセクションを記述した通常のMarkdownファイルです。
## Summary
## Changes
-
## Checklist
- [ ] Tests added
- [ ] Docs updated複数のテンプレート
.github/PULL_REQUEST_TEMPLATE/にファイルを配置し、クエリパラメーターで選択することで、複数のテンプレートを用意できます。
?template=bugfix.mdIssueの自動リンク
PRの本文でクローズキーワードを使うと、PRのマージ時に関連するIssueを自動的にクローズできます。
Closes #42ドラフトとテンプレートの組み合わせ
テンプレートを使って早い段階でドラフトを作成し、作業の進行に合わせて各セクションを記入してから、レビュー準備完了としてマークします。これにより、PRの形式を統一し、レビューしやすくできます。
理解度チェック
ドラフトPRとテンプレートについて、理解度を確認しましょう。
まとめ
ドラフトとテンプレートについて学びました。
- ドラフトPRは早い段階で作業を共有できますが、マージはできません
gh pr readyでドラフトをレビュー準備完了に変更します- テンプレートは
.github/pull_request_template.mdに保存します - クローズキーワードでIssueをリンクし、自動的にクローズできます
よくある質問
「Draft PR とプルリクエストテンプレート」レッスンは無料ですか?
はい。「Draft PR とプルリクエストテンプレート」の完全なテキストはこのウェブで無料で読めます。インタラクティブに演習し(組み込みコードエディタと24時間対応のAIチューター)、DevOps Bootcampコースの残りをアンロックするには、CoddyKit PROにアップグレードしてください。 DevOps Bootcampコースには全4レッスンが含まれています。
「Draft PR とプルリクエストテンプレート」で何を学びますか?
早い段階でフィードバックを得るための draft pull requests と、GitHub への貢献内容を標準化する PR templates の使い方を学びます。 ブラウザで直接実行するハンズオンコードでDevOps Bootcampを演習し、24時間対応のAIチューターがレッスンを進める中での質問に答えます。
DevOps Bootcampを始めるのに経験は必要ですか?
事前経験は必要ありません。CoddyKitのDevOps Bootcampは初級者から上級者向けに構成されているため、ここから始めるか最初から始めて、自分のペースで進むことができます。 これはレッスン4/4です。
「Draft PR とプルリクエストテンプレート」レッスンにはどのくらい時間がかかりますか?
ほとんどのCoddyKitレッスンは約5~10分かかります。各レッスンはコンパクトでインタラクティブなので、着実に進歩し、ウェブとアプリ全体で正確に前回の場所から再開できます。
このDevOps Bootcampレッスンでコードを書いて実行できますか?
はい。すべてのDevOps Bootcampレッスンに組み込みコードエディタが含まれているため、ブラウザでリアルコードを書いて実行し、即座のAIフィードバックを取得できます。ローカル設定は不要です。
このコースのすべてのレッスン
- Pull Requestの作成とレビュー
- GitHubでのForkワークフロー
- コードレビューと承認
- Draft PR とプルリクエストテンプレート