topical media & game development

talk show tell print

mobile-query-three-www-live-playground-vendor-CodeMirror2-doc-reporting.htm / htm



  <!doctype html>
  <html>
    <head>
      <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"/>
      <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
      <style>li { margin-top: 1em; }</style>
    </head>
    <body>
  
  <h1><span class="logo-braces">{ }</span> <a href="http://codemirror.net/">CodeMirror</a></h1>
  
  <pre class="grey">
  <img src="baboon.png" class="logo" alt="logo"/>/* Reporting bugs
     effectively */
  </pre>
  
  <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>
  


(C) Æliens 04/09/2009

You may not copy or print any of this material without explicit permission of the author or the publisher. In case of other copyright issues, contact the author.