Reporting Bugs

As HAL is still developed as a research tool (with limited resources at hand), we cannot guarantee flawless execution at all times. While our CI automatically checks for most types of bugs, some might slip through. So if you do want to help us further improving HAL, you can either try to fix bugs and crashes yourself (HAL is open-source after all), or provide us with a bug report comprising as many details as possible.

Sending Bug Reports

Please send your bug report to [email protected] (in case of sensitive information) or report it via the public GitHub Issues. In both cases, it would be great if you could provide us with all the material we need to replicate the issue, e.g.:

• your netlist
• your gate library (in case you are using a custom gate library that is not provided by HAL)
• your .hal file(s)
• your .log file(s)
• your Python scripts (in case they trigger the crash or bug)
• the crash report that is automatically generated at the location from which you execute HAL (in case of an actual crash, i.e., segfault)

We do understand that providing these information can be problematic in some instances. We assure you to treat everything you provide us with as confidential and guarantee to safely dispose of your files right after implementing a fix. If you cannot provide us with the requested files, we still appreciate a description of the discovered bugs that is as precise as possible.