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