Merge pull request #190 from sourcelair/contributing-md

Introduce CONTRIBUTING.md and Contributing section in README.md

diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
new file mode 100644 (file)
index 0000000..3593535
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE.md
@@ -0,0 +1,11 @@
+<!-- Enter your issue description here -->
+
+## Details
+- Browser and browser version: 
+- OS version: 
+- xterm.js version: 
+
+### Steps to reproduce
+
+1. 
+2. 

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644 (file)
index 0000000..8b33d18
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,52 @@
+# How to contribute to xterm.js
+
+- [Opening issues for bug reports or feature requests](#opening-issues)
+- [Contributing code](#contributing-code)
+
+## Opening issues
+
+The preferred way to report bugs or request features is to use
+[GitHub issues](http://github.com/sourcelair/xterm.js/issues). Before
+opening an issue, read these pointers.
+
+### Opening issues effectively
+
+- Include information about **the browser in which the problem occurred**. 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.
+
+- Mention which release of xterm.js you're using. Preferably, try also with
+  the current HEAD of the master branch, to ensure the problem has not already been
+  fixed.
+
+- Mention precisely what went wrong. What did you expect to happen? What happened instead? Describe the
+  exact steps a maintainer has to take to make the problem occur.
+
+- 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.
+
+- Be polite. Issues with an indignant or belligerent tone tend to be moved to the
+  bottom of the pile.
+
+## Contributing code
+
+- Make sure you have a [GitHub account](https://github.com/join)
+- Fork [xterm.js](https://github.com/sourcelair/xterm.js/)
+  ([how to fork a repo](https://help.github.com/articles/fork-a-repo))
+- Make your changes
+- If your changes are easy to test or likely to regress, add tests. Tests go into `test`, directory.
+- Follow the general code style of the rest of the project (see below).
+- Submit a pull request
+([how to create a pull request](https://help.github.com/articles/fork-a-repo)).
+  Don't put more than one feature/fix in a single pull request.
+
+By contributing code to xterm.js you
+
+ - agree to license the contributed code under xterm.js' [MIT
+   license](LICENSE).
+
+ - confirm that you have the right to contribute and license the code
+   in question. (Either you hold all rights on the code, or the rights
+   holder has explicitly granted the right to use it like this,
+   through a compatible open source license or through a direct
+   agreement with you.)

diff --git a/README.md b/README.md
index 1cd2756137c7881a22b5e8ac326bd77412b4b853..7c5ff60af06f4c27dfb9f536daa06f496f2ea5b5 100644 (file)
--- a/README.md
+++ b/README.md
@@ -51,11 +51,25 @@ var xterm = new Terminal();
 xterm.fit();
 ```
 
-## Contribution and License Agreement
+## Development and Contribution
 
-If you contribute code to this project, you are implicitly allowing your code to be distributed under the MIT license. You are also implicitly verifying that all code is your original work.
+To contribute either code, documentation or issues to xterm.js please read the [Contributing document](CONTRIBUTING.md) before.
+
+The development of xterm.js does not require any special tool. All you need is an editor that supports JavaScript and a browser (if you would like to run the demo you will need Node.js to get all features).
+
+It is recommended though to use a development tool that uses xterm.js internally, to develop for xterm.js. [Eating our own dogfood](https://en.wikipedia.org/wiki/Eating_your_own_dog_food) has been proved extremely beneficial for this project. Known tools that use xterm.js internally are:
+
+#### [SourceLair](https://www.sourcelair.com)
+
+Visit https://lair.io/sourcelair/xterm and follow the instructions. All development will happen in your browser.
 
-## License
+#### [Visual Studio Code](http://code.visualstudio.com/)
+
+[Download Visual Studio Code](http://code.visualstudio.com/Download), clone xterm.js and you are all set.
+
+## License Agreement
+
+If you contribute code to this project, you are implicitly allowing your code to be distributed under the MIT license. You are also implicitly verifying that all code is your original work.
 
 Copyright (c) 2014-2016, SourceLair, Private Company ([www.sourcelair.com](https://www.sourcelair.com/home)) (MIT License)