Reporting Bugs
Encountering a bug? Your detailed report is key for us to identify and rectify the issue.
Before reporting a bug, please review the following guidelines.
Search for Existing Issues
Before creating a new issue, search for existing issues to see if the bug has already been reported. If you find an existing issue, add a comment to it with any additional information you have.
Create a Bug Report
If you can’t find an existing issue, create a new one. When creating a bug report, follow these guidelines:
- Follow the Template: While creating a bug report on GitHub, adhere to the provided template for creating a clear and concise report.
- Reproduction Steps: Providing a reproduction example is essential.
- Artifacts: Include screenshots, logs, visibility artifacts, and any other relevant information. Be ready to provide more information upon request.
- Detailed Description: Avoid creating issues with brief descriptions or general error messages. Providing a thorough description and context is vital.
Tip
Creating a minimal code reproduction is crucial as it helps other contributors and maintainers understand and investigate the issue better. Issues without a reproduction are less likely to be addressed.