プルリクエストテンプレートビルダー

カスタマイズ可能なセクション、チェックリスト、プリセットでGitHubとGitLabのプルリクエストテンプレートを生成します。

このツールについて

プルリクエストテンプレートビルダーは、開発チームが一貫した構造のプルリクエストテンプレートを Markdownで作成するための無料ブラウザベースツールです。GitHubの.github/pull_request_template.mdや GitLabの.gitlab/merge_request_templates/ディレクトリのいずれにも対応し、チームのワークフローに 合わせたテンプレートを生成します。

6つのプリセット(Minimal、Standard、Detailed、Bug Fix、Feature、Hotfix)から選択するか、 個別のセクションをオン・オフ切り替えてカスタムテンプレートを作成できます。各セクション (説明、変更の種類、チェックリスト、スクリーンショット、テスト、関連Issue)は完全に カスタマイズ可能です。「APIドキュメントを更新」や「マイグレーションスクリプトを実行」 など、プロジェクト固有のチェックリスト項目を追加できます。

生成されるMarkdownにはGitHub Flavored Markdownのチェックボックス(- [ ] / - [x])、 コントリビューターへのガイドとなるHTMLコメントプレースホルダー、ビフォー・アフターの スクリーンショットテーブルが含まれます。ライブプレビューパネルでGitHubやGitLab上での 表示を確認してからファイルをコミットできます。

Gitワークフローに関連するツールとして、CIワークフローファイル作成には GitHub Actionsビルダー、 Conventional Commitsの強制にはGitコミットメッセージジェネレーター も便利です。一般的なMarkdown編集にはMarkdownプレビューをお試しください。

すべての処理はブラウザ内で完全に実行されます。データがサーバーに送信されることはありません。 テンプレートの内容はプライベートでローカルに保持されます。

使い方

  1. プラットフォーム(GitHubまたはGitLab)を選択して、正しいファイルパスのヒントを設定します。
  2. テンプレートプリセット(Minimal、Standard、Detailed、Bug Fix、Feature、Hotfix)を選んで、セクションとチェックリストを自動設定します。
  3. セクションパネルのチェックボックスで個別のセクションをオン・オフ切り替えます。
  4. 説明テスト関連Issueフィールドにプロジェクト固有の指示を入力します。
  5. 関連する変更の種類ボックスとチェックリスト項目をチェックして、テンプレートを事前入力します。
  6. 入力フィールドにテキストを入力してEnterキーまたは+ボタンをクリックして、カスタムチェックリスト項目を追加します。
  7. Markdownプレビュータブを切り替えて、生のMarkdownまたはレンダリング結果を確認します。CopyをクリックするかCtrl+Shift+Cを押してコピー、またはDownloadをクリックしてファイルを保存します。

人気のPRテンプレート例

すべてのPRテンプレート例を見る →

よくある質問

生成されたテンプレートファイルはどこに保存しますか?

GitHubの場合は、リポジトリルートに`.github/pull_request_template.md`として保存します。GitHubは新しいプルリクエスト作成時に自動的にデフォルトテンプレートとして使用します。GitLabの場合は、`.gitlab/merge_request_templates/`ディレクトリに保存します(例:`.gitlab/merge_request_templates/Default.md`)。

複数のPRテンプレートを使用できますか?

GitHubは`.github/PULL_REQUEST_TEMPLATE/`ディレクトリに複数のテンプレートを配置し、クエリパラメータで選択することで複数テンプレートをサポートしています。GitLabはネイティブに複数テンプレートをサポートしており、`.gitlab/merge_request_templates/`に複数の`.md`ファイルを追加するだけです。

テンプレート内のHTMLコメントは何のためですか?

HTMLコメント(`<!-- ... -->`)はGitHub/GitLab上のレンダリング済みMarkdownでは非表示ですが、編集時には表示されます。PRを記入するコントリビューターへの指示やヒントとして機能し、各セクションで提供すべき情報を理解する手助けをします。

チェックリスト項目をカスタマイズできますか?

はい。デフォルトのチェックリスト項目(コードスタイル、セルフレビュー、ドキュメント、テストなど)に加えて、チェックリストセクションの下部にある入力フィールドを使用してカスタム項目を追加できます。Xボタンをクリックしてカスタム項目を削除できます。

テンプレートプリセットの違いは何ですか?

Minimalは説明と関連Issueのみです。Standardは変更の種類、チェックリスト、テストを追加します。Detailedはすべてのセクションとカスタムチェックリスト項目を含みます。Bug FixとFeatureは変更の種類が事前にチェックされた標準テンプレートです。Hotfixは緊急修正用の簡略化テンプレートです。

データは安全ですか?

はい。すべてのテンプレート生成はJavaScriptを使用してブラウザ内で完全に実行されます。テンプレートの内容、チェックリスト項目、入力したテキストなどのデータがサーバーに送信されることはありません。ブラウザの開発者ツールのネットワークタブで確認できます。

プレビューはGitHub/GitLabのMarkdownレンダリングと一致しますか?

プレビューは近似的なレンダリングを提供します。GitHubとGitLabにはそれぞれ異なるMarkdownレンダラーとCSS スタイルがあるため、軽微な見た目の違いが予想されます。生のMarkdown出力は両プラットフォームと完全に互換性があります。

関連ツール