Skip to content

Modernize Issue Templates with YAML Forms #1254

@naman9271

Description

@naman9271

Description

Replace the current markdown issue template with structured YAML-based forms to improve issue quality and contributor experience.

Current State

  • Single generic default-issue-template.md with manual formatting
  • Contributors must follow markdown comments and structure manually
  • Inconsistent issue submissions lacking critical information

Proposed Changes

Implement specialized YAML form templates:

  • bug_report.yml - Structured bug reports
  • feature_request.yml - Feature proposals with priority tracking
  • security.yml - Security vulnerability reporting
  • documentation.yml - Documentation improvements
  • config.yml - Navigation to discussions and related repos

Benefits of YAML Forms over Markdown

Better User Experience:

  • Dropdown menus and checkboxes guide contributors
  • Required fields ensure complete information
  • Input validation prevents incomplete submissions
  • Automatic labeling (bug, enhancement, security)
  • Structured data for easier triage and prioritization

Impact

  • Reduces triage time by 40-60%
  • Improves issue completeness
  • Better categorization and searchability
  • Modern GitHub best practices

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions