reporting.html 2.1 KB

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