to-be-integrated/third-party/codemirror-3.15/doc/reporting.html

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