GitHub config.yml Template Chooser Setup

Configure the GitHub issue template chooser with config.yml to add custom links, disable blank issues, and control which templates appear in the selector.

Configuration

Detailed Explanation

GitHub config.yml Template Chooser

The config.yml file in .github/ISSUE_TEMPLATE/ customizes the issue template chooser that GitHub shows when users click "New issue". It controls whether blank issues are allowed and adds external links to the chooser.

config.yml Structure

blank_issues_enabled: false
contact_links:
  - name: "Security Vulnerabilities"
    url: "https://github.com/org/repo/security/advisories/new"
    about: "Please report security vulnerabilities through our security advisory process."
  - name: "Questions & Discussions"
    url: "https://github.com/org/repo/discussions"
    about: "Ask questions in GitHub Discussions instead of filing issues."
  - name: "Stack Overflow"
    url: "https://stackoverflow.com/questions/tagged/your-project"
    about: "Search for existing answers on Stack Overflow."

Disabling Blank Issues

Setting blank_issues_enabled: false forces all new issues to use a template. This prevents unstructured issues that lack necessary information but can also frustrate users who need to report something that does not fit any template.

Contact Links

Contact links appear alongside issue templates in the chooser. Common uses:

Link Target Purpose
Security advisories Route vulnerability reports to private channels
Discussions Redirect questions away from issues
Stack Overflow Point users to community support
Documentation Link to FAQ or troubleshooting guides

Complete Template Chooser Setup

A typical repository has:

  1. .github/ISSUE_TEMPLATE/bug-report.yml - Bug report form
  2. .github/ISSUE_TEMPLATE/feature-request.yml - Feature request form
  3. .github/ISSUE_TEMPLATE/config.yml - Chooser configuration

This combination provides structured templates for common issue types while directing other requests to appropriate channels.

Use Case

Repositories that want to control the issue filing experience, particularly popular open-source projects that receive a high volume of questions, support requests, and unstructured issues mixed in with legitimate bug reports.

Try It — Issue Template Builder

Open full tool