| 1 | <!DOCTYPE html> |
|---|
| 2 | <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
|---|
| 3 | <head> |
|---|
| 4 | <title>Bug reporting</title> |
|---|
| 5 | <link rel="stylesheet" type="text/css" href="style.css"/> |
|---|
| 6 | <meta charset="utf-8"/> |
|---|
| 7 | </head> |
|---|
| 8 | |
|---|
| 9 | <body> |
|---|
| 10 | <div class="header"> |
|---|
| 11 | <h1>Bug reporting</h1> |
|---|
| 12 | </div> |
|---|
| 13 | |
|---|
| 14 | <!--#include virtual="left-menu" --> |
|---|
| 15 | |
|---|
| 16 | <div style="margin-left:auto;margin-right:auto;width:20cm"> |
|---|
| 17 | <h2>A quick guide to producing meaningful bug reports for ABCL</h2> |
|---|
| 18 | |
|---|
| 19 | This guide describes how to report bugs in ABCL. When you think you've |
|---|
| 20 | found a bug, send a bug report to |
|---|
| 21 | the <a href="http://common-lisp.net/cgi-bin/mailman/listinfo/armedbear-devel">mailing |
|---|
| 22 | list</a>. For the bug report to be most useful, try and do the |
|---|
| 23 | following things: |
|---|
| 24 | |
|---|
| 25 | <ol> |
|---|
| 26 | <li> |
|---|
| 27 | Use a descriptive subject, stating a brief summary of the bug, and |
|---|
| 28 | mentioning that you're reporting a bug. Don't be fussy about the format |
|---|
| 29 | of the subject, we don't process the bugs automatically, just try to |
|---|
| 30 | provide a meaningful description.</li> |
|---|
| 31 | <li> |
|---|
| 32 | Add a short program snippet that demonstrates what ABCL does incorrectly, |
|---|
| 33 | and if necessary, quote any relevant portions in the <a href="http://www.lispworks.com/documentation/HyperSpec/Front/index.htm">Common Lisp standard</a>. |
|---|
| 34 | </li> |
|---|
| 35 | <li> |
|---|
| 36 | Differences between ABCL and other Common Lisp implementations are useful |
|---|
| 37 | information, if you find that some other Common Lisp implementation works |
|---|
| 38 | correctly and ABCL has a bug, it helps us in fixing the problem, so |
|---|
| 39 | try your program snippet on other implementations as well and post |
|---|
| 40 | the results. |
|---|
| 41 | </li> |
|---|
| 42 | <li> |
|---|
| 43 | Try and answer any questions asked about your bug report. |
|---|
| 44 | </li> |
|---|
| 45 | <li> |
|---|
| 46 | It is very much appreciated if you can actually find what's causing |
|---|
| 47 | the bug in ABCL codebase and even better still if you can produce |
|---|
| 48 | a <a href="contributing.shtml">patch</a> that fixes the problem. Don't |
|---|
| 49 | fret if you can't, though, reports without patches are warmly welcomed, but |
|---|
| 50 | we highly appreciate patch contibutions. |
|---|
| 51 | </li> |
|---|
| 52 | </ol> |
|---|
| 53 | |
|---|
| 54 | After all that, sit back, relax and enjoy yourself, the bug should |
|---|
| 55 | get fixed eventually. The maintainers of ABCL are usually rather |
|---|
| 56 | busy, but we will take a look at all bug reports when we have time. |
|---|
| 57 | </div> |
|---|
| 58 | |
|---|
| 59 | <div class="footer"> |
|---|
| 60 | <hr /> |
|---|
| 61 | <p>Hosted as part of <a href="https://common-lisp.net/">common-lisp.net</a></p> |
|---|
| 62 | </div> |
|---|
| 63 | </body> |
|---|
| 64 | </html> |
|---|
