Reporting a Bug/Issue
If you have come across a bug, or have an issue building or running ILLIXR, please try the following:
- Ensure the bug was not already reported by searching on GitHub under Issues.
- If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title, clear description, and as much relevant information as possible. This may include:
- Steps to reproduce the bug.
- Command line arguments.
- Any data sets being used.
- Expected behavior.
- Actual behavior.
- Which plugins are being used.
- The contents of any configuration files.
- Any relevant environment variables.
- Build commands and arguments.
- Screenshots or error messages.
- System information (OS, hardware, etc.).
- Any other relevant information.
- If the issue regards running ILLIXR, please try doing a
Debug
build, if you have not already. This build will output more information and may help narrow down where the problem is arising from. - Once the issue is created a team member will review it and work to resolve the issue.