|
| 1 | +<!doctype html> |
| 2 | +<html> |
| 3 | + <head> |
| 4 | + <title>CodeMirror: Reporting Bugs</title> |
| 5 | + <link rel="stylesheet" type="text/css" href="http://fonts.googleapis.com/css?family=Droid+Sans|Droid+Sans:bold"/> |
| 6 | + <link rel="stylesheet" type="text/css" href="../doc/docs.css"/> |
| 7 | + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> |
| 8 | + <style>li { margin-top: 1em; }</style> |
| 9 | + </head> |
| 10 | + <body> |
| 11 | + |
| 12 | +<h1><span class="logo-braces">{ }</span> <a href="http://codemirror.net/">CodeMirror</a></h1> |
| 13 | + |
| 14 | +<pre class="grey"> |
| 15 | +<img src="../doc/baboon.png" class="logo" alt="logo"/>/* Reporting bugs |
| 16 | + effectively */ |
| 17 | +</pre> |
| 18 | + |
| 19 | +<div class="left"> |
| 20 | + |
| 21 | +<p>So you found a problem in CodeMirror. By all means, report it! Bug |
| 22 | +reports from users are the main drive behind improvements to |
| 23 | +CodeMirror. But first, please read over these points:</p> |
| 24 | + |
| 25 | +<ol> |
| 26 | + <li>CodeMirror is maintained by volunteers. They don't owe you |
| 27 | + anything, so be polite. Reports with an indignant or belligerent |
| 28 | + tone tend to be moved to the bottom of the pile.</li> |
| 29 | + |
| 30 | + <li>Include information about <strong>the browser in which the |
| 31 | + problem occurred</strong>. Even if you tested several browsers, and |
| 32 | + the problem occurred in all of them, mention this fact in the bug |
| 33 | + report. Also include browser version numbers and the operating |
| 34 | + system that you're on.</li> |
| 35 | + |
| 36 | + <li>Mention which release of CodeMirror you're using. Preferably, |
| 37 | + try also with the current development snapshot, to ensure the |
| 38 | + problem has not already been fixed.</li> |
| 39 | + |
| 40 | + <li>Mention very precisely what went wrong. "X is broken" is not a |
| 41 | + good bug report. What did you expect to happen? What happened |
| 42 | + instead? Describe the exact steps a maintainer has to take to make |
| 43 | + the problem occur. We can not fix something that we can not |
| 44 | + observe.</li> |
| 45 | + |
| 46 | + <li>If the problem can not be reproduced in any of the demos |
| 47 | + included in the CodeMirror distribution, please provide an HTML |
| 48 | + document that demonstrates the problem. The best way to do this is |
| 49 | + to go to <a href="http://jsbin.com/ihunin/edit">jsbin.com</a>, enter |
| 50 | + it there, press save, and include the resulting link in your bug |
| 51 | + report.</li> |
| 52 | +</ol> |
| 53 | + |
| 54 | +</div> |
| 55 | + |
| 56 | + </body> |
| 57 | +</html> |
0 commit comments