openml / openml/OpenML

Modernize Issue Templates with YAML Forms

Open
#1,254 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
PHP
Stars
755
Forks
128
PR merge metrics
No merged PRs in 30d

Description

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

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the current default-issue-template.md and GitHub's YAML issue form requirements. Add bug_report.yml, feature_request.yml, security.yml, documentation.yml, and config.yml with the proposed structured fields, validation, labels, and navigation; done means contributors can use the specialized forms and reach discussions or related repositories through config.yml.

Written by the indexing model from the issue text.

Assessment

Tech stack
github, yaml
Domain
developer-experience, tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.