Skip to content

Bug Report Template Configuration

The BugReportConfigFile manages the .github/ISSUE_TEMPLATE/bug_report.yml file.

Overview

Creates a bug report issue template that:

  • Provides structured fields for bug reports
  • Uses GitHub's YAML issue forms
  • Auto-labels issues with bug

Inheritance

graph TD A[ConfigFile] --> B[YamlConfigFile] B --> C[YmlConfigFile] C --> D[BugReportConfigFile] 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

File Location

Path: .github/ISSUE_TEMPLATE/bug_report.yml

Template Fields

Field Type Required
Description textarea
Steps to Reproduce textarea
Expected Behavior textarea
Actual Behavior textarea
Environment textarea
Logs textarea

Automatic Creation

uv run pyrig mkroot

Validation Logic

File must exist and contain text. Users can customize the template.

See Also