Issueテンプレートビルダー

GitHubおよびGitLabのIssueテンプレートをビジュアルに構築。YAMLイシューフォームまたはクラシックMarkdownテンプレートをカスタムセクションで生成。

このツールについて

Issueテンプレートビルダーは、GitHubのIssueフォームテンプレート(YAML)およびクラシックなMarkdown Issueテンプレートを ビジュアルインターフェースを通じて作成する無料のブラウザベースツールです。YAML構文をゼロから書く代わりに、 テンプレートタイプを選択し、ラベルや担当者などのメタデータを設定し、 ドラッグ&ドロップスタイルのビルダーでフォームセクションを追加します。

このツールはGitHub Issueフォームの5つのフィールドタイプすべてをサポートしています: 複数行テキスト入力のtextarea、単一行テキストのinput、選択メニューのdropdown、 チェックリストのcheckboxes、静的な説明テキストのmarkdownです。 各フィールドを必須またはオプションに設定し、説明やプレースホルダーを追加し、 上下コントロールでセクションの順序を変更できます。

4つのプリセットテンプレートが用意されています:バグレポート、機能リクエスト、 ドキュメントIssue、カスタム。各プリセットにはカスタマイズ可能な適切なデフォルトセクションが含まれています。 出力フォーマット切り替えにより、GitHubの新しいYAML Issueフォーム構文と GitHubおよびGitLabの両方で使用されるクラシックMarkdownテンプレートフォーマットを切り替えられます。

GitHub Actionsワークフローを扱う場合は、同様のビジュアル構築体験の GitHub Actionsワークフロービルダーをお試しください。 Markdown出力のプレビューには、Markdownプレビューツールが便利です。

すべての処理はブラウザ内で完全に実行されます。テンプレートデータ、リポジトリ名、 ラベルがサーバーに送信されることはありません。テンプレートはデバイス上で即座に生成され、 直接コピーまたはダウンロードできます。

使い方

  1. ドロップダウンからテンプレートタイプを選択します(バグレポート、機能リクエスト、ドキュメントIssue、カスタム)。
  2. 出力フォーマットを選択します:GitHub IssueフォームのYAML、またはGitHubとGitLabの両方に対応するクラシックMarkdown。
  3. テンプレートメタデータを入力します:名前、説明、タイトルプレフィックス、ラベル、担当者。
  4. セクションリストの上のボタンを使ってフォームセクションを追加・設定します。各セクションタイプ(textarea、input、dropdown、checkboxes、markdown)にはそれぞれの設定オプションがあります。
  5. 上下矢印ボタンでセクションの順序を変更するか、ゴミ箱アイコンで削除します。
  6. 出力パネルで生成されたテンプレートを確認します。コードビューとプレビューを切り替えてフォームの見た目を確認できます。
  7. CopyをクリックするかCtrl+Shift+Cを押してテンプレートをコピーするか、Downloadをクリックして.ymlまたは.mdファイルとして保存します。

人気のIssueテンプレート例

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

よくある質問

YAML IssueフォームとMarkdownテンプレートの違いは何ですか?

GitHubのYAML Issueフォーム(2021年導入)は、ドロップダウンやチェックボックスなどの特定のフィールドタイプを持つ構造化フォームを作成します。一貫性があり、機械解析可能なIssueを生成します。クラシックMarkdownテンプレートは、ユーザーが自由に編集できる事前入力済みのMarkdownドキュメントを提供します。YAMLフォームはより良い構造を、Markdownテンプレートはより柔軟性を提供します。GitLabは現在Markdownフォーマットのみをサポートしています。

生成されたテンプレートファイルはリポジトリのどこに置きますか?

GitHub YAMLイシューフォームの場合、.github/ISSUE_TEMPLATE/bug-report.yml(.ymlで終わる任意の名前)として保存します。クラシックMarkdownテンプレートの場合、.github/ISSUE_TEMPLATE/bug-report.mdとして保存します。GitHubは.github/ISSUE_TEMPLATE/ディレクトリ内のテンプレートを自動的に検出します。GitLabの場合、.gitlab/issue_templates/ディレクトリにMarkdownテンプレートを配置します。

1つのリポジトリに複数のIssueテンプレートを置けますか?

はい。.github/ISSUE_TEMPLATE/ディレクトリに好きなだけテンプレートファイルを追加できます。GitHubは新しいIssue作成時にテンプレート選択画面をユーザーに表示します。config.ymlファイルを追加して、外部リンクでチューザーをカスタマイズしたり、空白のIssueを無効にしたりすることもできます。

GitHub Issueフォームで利用可能なフィールドタイプは?

GitHub Issueフォームは5つのフィールドタイプをサポートしています:textarea(オプションのMarkdownレンダリング付き複数行テキスト入力)、input(オプションのバリデーション正規表現付き単一行テキスト)、dropdown(単一または複数選択の選択メニュー)、checkboxes(チェック可能な項目リスト)、markdown(説明用の静的表示テキスト)。markdown以外の各タイプには必須にするバリデーションオプションがあります。

フォームフィールドにデフォルト値を追加するには?

このビルダーでは、textareaとinputフィールドにプレースホルダーテキストを設定できます。dropdownフィールドでは最初のオプションがデフォルトで表示されます。生成されたYAMLでは、textareaまたはinputフィールドに手動で'value'属性を追加して、ユーザーが変更できるデフォルトテキストを事前入力できます。

データは安全ですか?

はい。すべてのテンプレート生成はJavaScriptを使用してブラウザ内で完全に実行されます。テンプレート名、ラベル、担当者、フォームコンテンツなどのデータがサーバーに送信されることはありません。ツール使用中にブラウザの開発者ツールのネットワークタブで確認できます。

GitLabのIssueテンプレートにも使えますか?

はい、ただし制限があります。'クラシックMarkdownテンプレート'出力フォーマットを選択してください。GitHubとGitLabの両方に対応するMarkdownが生成されます。GitLabはYAML Issueフォーム構文をサポートしていないため、GitLabリポジトリにはMarkdownフォーマットを使用してください。生成されたファイルはリポジトリの.gitlab/issue_templates/に保存してください。

関連ツール