38 lines
2.0 KiB
ReStructuredText
38 lines
2.0 KiB
ReStructuredText
|
|
||
|
|
Reporting Issues
|
||
|
|
================
|
||
|
|
|
||
|
|
The developers of and contributers to Icarus Verilog use github to track
|
||
|
|
issues and to create patches for the product. If you believe you have found a
|
||
|
|
problem, use the Issues tracker at the
|
||
|
|
`Icarus Verilog github page <https://github.com/steveicarus/iverilog>`_.
|
||
|
|
|
||
|
|
On the main page, you will find a row of selections near the top. Click the
|
||
|
|
`Issues <https://github.com/steveicarus/iverilog/issues>`_ link to get to the
|
||
|
|
list of issues, open and closed. You will find a friendly green button where
|
||
|
|
you can create a new issue. You will be asked to create a title for your
|
||
|
|
issue, and to write a detailed description of your issue. Please include
|
||
|
|
enough information that anyone who sees your issue can understand and
|
||
|
|
reproduce it.
|
||
|
|
|
||
|
|
One key characteristic of a well reported issue is a small sample program that
|
||
|
|
demonstrates the issue. The smaller the better. No developer wants to wade
|
||
|
|
through hundreds of lines of working Verilog to find the few lines that cause
|
||
|
|
trouble, so if you can get it down to a 10 line sample program, then your
|
||
|
|
issue will be far more likely to be addressed.
|
||
|
|
|
||
|
|
Be prepared to have a conversation about your issue. More often then you would
|
||
|
|
expect, the issue turns out to be a bug in your program, and the person
|
||
|
|
looking into your issue may point out a bug in your code. You learn something,
|
||
|
|
and we all win. We are not always correct, though, so if we are incorrect,
|
||
|
|
help us see our error, if that's appropriate. If we don't understand what your
|
||
|
|
issue is, we will label your issue with a "Need info" label, and if we never
|
||
|
|
hear from you again, your issue may be closed summarily.
|
||
|
|
|
||
|
|
If you can submit a complete, working program that we can use in the
|
||
|
|
regression test suite, then that is the best. Check out the existing tests in
|
||
|
|
the regression test suite to see how they are structured. If you have a
|
||
|
|
complete test that can go into the test suite, then that saves everyone a lot
|
||
|
|
of grief, and again you increase the odds that your issue will be addressed.
|
||
|
|
|