| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960 |
- <!doctype html>
- <html>
- <head>
- <meta charset="utf-8"/>
- <title>CodeMirror: Reporting Bugs</title>
- <link rel="stylesheet" type="text/css" href="http://fonts.googleapis.com/css?family=Droid+Sans|Droid+Sans:bold"/>
- <link rel="stylesheet" type="text/css" href="docs.css"/>
- <style>li { margin-top: 1em; }</style>
- </head>
- <body>
- <h1><span class="logo-braces">{ }</span> <a href="http://codemirror.net/">CodeMirror</a></h1>
- <div class="grey">
- <img src="baboon.png" class="logo" alt="logo"/>
- <pre>
- /* Reporting bugs
- effectively */
- </pre>
- </div>
- <div class="left">
- <p>So you found a problem in CodeMirror. By all means, report it! Bug
- reports from users are the main drive behind improvements to
- CodeMirror. But first, please read over these points:</p>
- <ol>
- <li>CodeMirror is maintained by volunteers. They don't owe you
- anything, so be polite. Reports with an indignant or belligerent
- tone tend to be moved to the bottom of the pile.</li>
- <li>Include information about <strong>the browser in which the
- problem occurred</strong>. Even if you tested several browsers, and
- the problem occurred in all of them, mention this fact in the bug
- report. Also include browser version numbers and the operating
- system that you're on.</li>
- <li>Mention which release of CodeMirror you're using. Preferably,
- try also with the current development snapshot, to ensure the
- problem has not already been fixed.</li>
- <li>Mention very precisely what went wrong. "X is broken" is not a
- good bug report. What did you expect to happen? What happened
- instead? Describe the exact steps a maintainer has to take to make
- the problem occur. We can not fix something that we can not
- observe.</li>
- <li>If the problem can not be reproduced in any of the demos
- included in the CodeMirror distribution, please provide an HTML
- document that demonstrates the problem. The best way to do this is
- to go to <a href="http://jsbin.com/ihunin/edit">jsbin.com</a>, enter
- it there, press save, and include the resulting link in your bug
- report.</li>
- </ol>
- </div>
- </body>
- </html>
|
