GitHub config.ymlテンプレート選択画面の設定
config.ymlでGitHub Issueテンプレート選択画面をカスタマイズし、カスタムリンクの追加、空白Issue の無効化、表示テンプレートの制御を行います。
Configuration
詳細な説明
GitHub config.ymlテンプレート選択画面
.github/ISSUE_TEMPLATE/内のconfig.ymlファイルは、ユーザーが「New issue」をクリックした際にGitHubが表示するIssueテンプレート選択画面をカスタマイズします。
config.yml構造
blank_issues_enabled: false
contact_links:
- name: "セキュリティ脆弱性"
url: "https://github.com/org/repo/security/advisories/new"
about: "セキュリティアドバイザリプロセスを通じて脆弱性を報告してください。"
- name: "質問とディスカッション"
url: "https://github.com/org/repo/discussions"
about: "Issueの代わりにGitHub Discussionsで質問してください。"
空白Issueの無効化
blank_issues_enabled: falseを設定すると、すべての新しいIssueにテンプレートの使用を強制します。これにより必要な情報を欠いた非構造化Issueを防ぎますが、テンプレートに合わない報告が必要なユーザーを困らせる可能性もあります。
コンタクトリンク
コンタクトリンクはテンプレート選択画面でIssueテンプレートと並んで表示されます。脆弱性レポートをプライベートチャンネルにルーティングしたり、質問をIssueからリダイレクトするなどの一般的な用途があります。
ユースケース
Issue提出体験を制御したいリポジトリ、特に質問やサポートリクエスト、正当なバグレポートに混じった非構造化Issueを大量に受ける人気のオープンソースプロジェクト。