Daily Backlog Burner: Add comprehensive issue templates for improved triage

[dsyme]

Summary

This PR implements Phase 4 goals from the Daily Backlog Burner roadmap (issue #7903) by adding comprehensive issue templates to improve issue triage, quality, and community engagement.

Problem Statement

The Z3 repository currently lacks structured issue templates, leading to:

• Inconsistent issue quality: Missing critical information (versions, platforms, reproduction steps)
• High maintainer overhead: Time spent asking for basic details repeatedly
• Poor categorization: Difficulty prioritizing and routing issues appropriately
• Unclear reporting paths: Users unsure whether to use Issues vs Discussions vs Stack Overflow

Analysis of the backlog revealed common patterns where issues lack essential information, making triage and resolution significantly more difficult.

Solution: Comprehensive Issue Template System

Added 6 specialized templates covering all major issue categories identified in the backlog analysis:

🐛 Bug Report Template

• Structured reporting: Category, description, minimal reproduction, expected vs actual behavior
• Technical details: Z3 version, platform, interface used, installation method
• Regression tracking: Checkboxes to identify if issues worked in previous versions
• Pre-submission checklist: Ensures completeness before submission

⚡ Performance Issue Template

• Performance-specific fields: Timing measurements, memory usage, system specs
• Regression detection: Specific fields for identifying version regressions
• Theory classification: Helps route to appropriate experts (bitvectors, strings, etc.)
• Configuration context: Solver options, tactics, workarounds found

✨ Feature Request Template

• Clear motivation: Use cases, problem being solved, priority assessment
• Implementation planning: Helper availability, compatibility considerations
• Related work: References to similar features, research, standards
• Example usage: Code samples showing desired API/behavior

❓ Question Template

• Channel guidance: Clear direction toward Discussions, Stack Overflow, or documentation
• Qualifying criteria: Only for Z3-specific behavior/design questions
• Research tracking: Documents what user has already investigated
• Documentation improvement: Questions that could lead to doc enhancements

🔧 Build/Installation Template

• Environment details: Platform, compiler, dependencies, build commands
• Complete error output: Structured field for full error messages
• Systematic debugging: Standard fields for all build environments
• Documentation links: Direct references to build guides

📋 Other Issues Template

• Catch-all coverage: Documentation, security, governance, CI issues
• Category classification: Helps route non-standard issues appropriately

⚙️ Configuration Features

• External resource guidance: Config file directs users to Discussions, Stack Overflow, documentation
• Disabled blank issues: Encourages structured reporting
• Comprehensive resource links: Z3 Guide, API docs, academic resources

Benefits

🎯 Immediate Impact

• Higher quality issues: Structured templates ensure essential information is captured
• Faster triage: Clear categorization enables quick routing to appropriate maintainers
• Reduced back-and-forth: Pre-submission checklists minimize incomplete reports

📊 Improved Metrics

• Better signal-to-noise ratio: Templates filter well-formed issues from noise
• Easier prioritization: Clear categories (Bug/Performance/Feature) enable better priority assignment
• Faster resolution: Complete information upfront reduces investigation time

🤝 Community Benefits

• Better contributor experience: Clear guidance on where and how to report issues
• Reduced maintainer burden: Less time spent asking for missing information
• Knowledge distribution: Templates educate users about Z3 ecosystem (Discussions, Stack Overflow)

Implementation Details

Template Design Principles

• Comprehensive coverage: Based on actual backlog analysis patterns
• User-friendly: Clear instructions and helpful placeholder text
• Maintainer-focused: Fields optimized for efficient triage and debugging
• Community-aware: Integration with external resources and alternative channels

Quality Assurance

• Checkbox validations: Ensures critical fields are completed
• Pre-submission checklists: Reduces incomplete or duplicate reports
• Clear formatting: Syntax highlighting for code/SMT-LIB2 examples
• External resource integration: Reduces inappropriate issue creation

Alignment with Roadmap Goals

This directly implements Phase 4: Maintenance priorities from issue #7903:

✅ Issue Triage System: Automated structure through templates
✅ Issue template improvements: Comprehensive coverage of all issue types
✅ Clear categorization guidelines: Built into template structure
✅ Community Engagement: Integration with Discussions and external resources

Testing

• ✅ Template syntax validated: All YAML templates use correct GitHub format
• ✅ Comprehensive coverage: Templates address all major issue patterns from backlog analysis
• ✅ User experience tested: Clear flows from issue creation to appropriate resources
• ✅ Integration verified: Config file properly directs users to external channels

Expected Outcomes

Short-term (1-3 months)

• Improved issue quality: More complete information in new issues
• Faster initial triage: Clear categorization enables quick routing
• Reduced duplicate reports: Better search guidance and issue structure

Medium-term (3-6 months)

• Lower maintenance overhead: Less time spent requesting missing information
• Better metrics: Clearer patterns in issue types and priorities
• Community growth: Better experience encourages higher quality contributions

Long-term (6+ months)

• Sustainable backlog management: Structured process prevents backlog accumulation
• Data-driven decisions: Better categorization enables analysis of common issues
• Community self-service: Users find answers through guided external resources

Related Issues

• Addresses Phase 4 goals from Daily Backlog Burner roadmap (issue Daily Backlog Burner - Research, Roadmap and Plan #7903)
• Implements "Issue Triage System" improvements identified in backlog analysis
• Supports "Community Engagement" goals through external resource integration

Maintainer Notes

This implementation addresses a foundational need identified in the comprehensive backlog analysis. The templates are designed based on actual patterns observed in the current issue backlog, ensuring they capture the information needed for efficient triage and resolution.

The external resource integration (Discussions, Stack Overflow) helps distribute community support load while keeping the issue tracker focused on actionable bugs and enhancements.

AI-generated content by Daily Backlog Burner may contain mistakes.

Generated by Agentic Workflow Run