Skip to content

Issue guidelines

This guide outlines the process for creating effective issues that help maintainers and the community understand and address your needs efficiently. Following these guidelines ensures faster resolution and better collaboration.

We provide several channels for reporting issues and seeking assistance, each designed for specific purposes:

Before creating an issue

  •   Review the documentation thoroughly
  •   Search existing issues for similar reports
  •   Test with the latest framework version
  •   Gather all relevant system information

Bug reports

Bug reports help us identify and fix problems in the framework. When submitting a bug report, you should:

  • Verify the issue with the latest framework version
  • Provide comprehensive system information
  • Include steps to reproduce the problem
  • Detail expected versus actual behavior

Submit a bug report

Feature requests

Feature requests are managed through GitHub Discussions to facilitate community engagement and collaborative refinement. You can share your ideas for improving the framework by providing detailed context and use cases:

  • Clear problem statement
  • Proposed implementation approach
  • Specific use cases and scenarios
  • Expected benefits to the community

Propose a feature

Questions

A question template is available to help structure your inquiry effectively:

Ask a question

For general inquiries and technical assistance, we also offer multiple support channels:

Issue management

  • Issue categories

    •   bug - Bug reports
    •   documentation - Documentation issues
    •   duplicate - Duplicate issues
    •   enhancement - Feature requests
    •   good-first-issue - Beginner-friendly tasks
    •   help-wanted - Assistance requests
    •   invalid - Invalid issues
    •   question - General questions
    •   performance - Performance concerns
    •   wontfix - Closed issues

  • Process

    1. Initial triage
    2. Priority assessment and labeling
    3. Assignment to future release
    4. Implementation and testing
    5. Community review and feedback
    6. Resolution and closure


Need assistance?

Join our Discord community for real-time support and discussion.