aiondemand / aiondemand/AIOD-rest-api

Modernize Issue Templates with YAML Forms

Aperta
#658 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
Lingua principale
Python
Stelle
36
Fork
77
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

### 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

Guida per i contributori

Apri la guida per i contributori

Valutazione

Questa issue non è ancora stata valutata.

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.