Skip to content

Issue Template Config Configuration

The ConfigConfigFile manages the .github/ISSUE_TEMPLATE/config.yml file.

Overview

Creates an issue template chooser configuration that:

  • Controls the template chooser behavior
  • Disables blank issues by default
  • Can add external links to the chooser

Inheritance

graph TD A[ConfigFile] --> B[YamlConfigFile] B --> C[YmlConfigFile] C --> D[ConfigConfigFile] style A fill:#a8dadc,stroke:#333,stroke-width:2px,color:#000 style B fill:#457b9d,stroke:#333,stroke-width:2px,color:#fff style C fill:#f4a261,stroke:#333,stroke-width:2px,color:#000 style D fill:#90be6d,stroke:#333,stroke-width:2px,color:#000

Inherits from: YmlConfigFile

What this means:

  • YAML file format (.yml extension)
  • Dict-based configuration
  • Uses PyYAML for parsing/writing

File Location

Path: .github/ISSUE_TEMPLATE/config.yml

Extension: .yml - GitHub configuration format.

Generated Content

blank_issues_enabled: false

This configuration:

  • Disables blank issues: Users must use a template
  • Forces structured issue reports
  • Improves issue quality and actionability

Automatic Creation

uv run pyrig mkroot

Validation Logic

The validation checks if config.yml exists and is non-empty. This allows users to customize the configuration while still being considered valid.

Required element: File must exist and contain text.

Customization

Edit the generated YAML file to:

Enable Blank Issues

blank_issues_enabled: true

blank_issues_enabled: false
contact_links:
  - name: Documentation
    url: https://example.com/docs
    about: Read the documentation before opening an issue
  - name: Discussions
    url: https://github.com/owner/repo/discussions
    about: Ask questions in GitHub Discussions

See Also