You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

60 lines
2.0 KiB

7 months ago
  1. <!doctype html>
  2. <title>CodeMirror: Reporting Bugs</title>
  3. <meta charset="utf-8"/>
  4. <link rel=stylesheet href="docs.css">
  5. <div id=nav>
  6. <a href="https://codemirror.net/5"><h1>CodeMirror</h1><img id=logo src="logo.png"></a>
  7. <ul>
  8. <li><a href="../index.html">Home</a>
  9. <li><a href="manual.html">Manual</a>
  10. <li><a href="https://github.com/codemirror/codemirror5">Code</a>
  11. </ul>
  12. <ul>
  13. <li><a class=active href="#">Reporting bugs</a>
  14. </ul>
  15. </div>
  16. <article>
  17. <h2>Reporting bugs effectively</h2>
  18. <div class="left">
  19. <p>So you found a problem in CodeMirror. By all means, report it! Bug
  20. reports from users are the main drive behind improvements to
  21. CodeMirror. But first, please read over these points:</p>
  22. <ol>
  23. <li>CodeMirror is maintained by volunteers. They don't owe you
  24. anything, so be polite. Reports with an indignant or belligerent
  25. tone tend to be moved to the bottom of the pile.</li>
  26. <li>Include information about <strong>the browser in which the
  27. problem occurred</strong>. Even if you tested several browsers, and
  28. the problem occurred in all of them, mention this fact in the bug
  29. report. Also include browser version numbers and the operating
  30. system that you're on.</li>
  31. <li>Mention which release of CodeMirror you're using. Preferably,
  32. try also with the current development snapshot, to ensure the
  33. problem has not already been fixed.</li>
  34. <li>Mention very precisely what went wrong. "X is broken" is not a
  35. good bug report. What did you expect to happen? What happened
  36. instead? Describe the exact steps a maintainer has to take to reproduce
  37. the error. We can not fix something that we can not observe.</li>
  38. <li>If the problem can not be reproduced in any of the demos
  39. included in the CodeMirror distribution, please provide an HTML
  40. document that demonstrates the problem. The best way to do this is
  41. to go to <a href="http://jsbin.com/ihunin/1/edit">jsbin.com</a>, enter
  42. it there, press save, and include the resulting link in your bug
  43. report.</li>
  44. </ol>
  45. </div>
  46. </article>