OLD | NEW |
(Empty) | |
| 1 # How to contribute to xterm.js |
| 2 |
| 3 - [Opening issues for bug reports or feature requests](#opening-issues) |
| 4 - [Contributing code](#contributing-code) |
| 5 |
| 6 ## Opening issues |
| 7 |
| 8 The preferred way to report bugs or request features is to use |
| 9 [GitHub issues](http://github.com/sourcelair/xterm.js/issues). Before |
| 10 opening an issue, read these pointers. |
| 11 |
| 12 ### Opening issues effectively |
| 13 |
| 14 - Include information about **the browser in which the problem occurred**. Even |
| 15 if you tested several browsers, and the problem occurred in all of them, |
| 16 mention this fact in the bug report. Also include browser version numbers and |
| 17 the operating system that you're on. |
| 18 |
| 19 - Mention which release of xterm.js you're using. Preferably, try also with |
| 20 the current HEAD of the master branch, to ensure the problem has not already b
een |
| 21 fixed. |
| 22 |
| 23 - Mention precisely what went wrong. What did you expect to happen? What happene
d instead? Describe the |
| 24 exact steps a maintainer has to take to make the problem occur. |
| 25 |
| 26 - If the problem can not be reproduced in the [demo of xterm.js](README.md#demo)
, please provide an HTML document that demonstrates the problem. |
| 27 |
| 28 - Be polite. Issues with an indignant or belligerent tone tend to be moved to th
e |
| 29 bottom of the pile. |
| 30 |
| 31 ## Contributing code |
| 32 |
| 33 - Make sure you have a [GitHub account](https://github.com/join) |
| 34 - Fork [xterm.js](https://github.com/sourcelair/xterm.js/) |
| 35 ([how to fork a repo](https://help.github.com/articles/fork-a-repo)) |
| 36 - Make your changes |
| 37 - If your changes are easy to test or likely to regress, add tests. Tests go int
o `test`, directory. |
| 38 - Follow the general code style of the rest of the project (see below). |
| 39 - Submit a pull request |
| 40 ([how to create a pull request](https://help.github.com/articles/fork-a-repo)). |
| 41 Don't put more than one feature/fix in a single pull request. |
| 42 |
| 43 By contributing code to xterm.js you |
| 44 |
| 45 - agree to license the contributed code under xterm.js' [MIT |
| 46 license](LICENSE). |
| 47 |
| 48 - confirm that you have the right to contribute and license the code |
| 49 in question. (Either you hold all rights on the code, or the rights |
| 50 holder has explicitly granted the right to use it like this, |
| 51 through a compatible open source license or through a direct |
| 52 agreement with you.) |
OLD | NEW |