XMPP: Update to Converse 0.10.0

[friendica-addons.git] / xmpp / converse / CONTRIBUTING.rst

diff --git a/xmpp/converse/CONTRIBUTING.rst b/xmpp/converse/CONTRIBUTING.rst
new file mode 100644 (file)
index 0000000..49d7193
--- /dev/null
+++ b/xmpp/converse/CONTRIBUTING.rst
@@ -0,0 +1,37 @@
+=======================
+Contribution Guidelines
+=======================
+
+Thanks for contributing to `Converse.js <http://conversejs.org>`_.
+
+Support questions
+=================
+Please ask support and setup questions on the mailing list: conversejs@librelist.com
+
+The issue tracker is only for bugs (i.e. issues) and feature requests.
+
+Contributing Code
+=================
+Please follow the usual github workflow. Create your own local fork of this repository,
+make your changes and then submit a pull request.
+
+Before submitting a pull request
+--------------------------------
+
+Please read the `style guide <https://conversejs.org/docs/html/style_guide.html>`_ and make sure that your code follows it.
+
+Add tests for your bugfix or feature
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Add a test for any bug fixed or feature added. We use Jasmine
+for testing. 
+
+Take a look at `tests.html <https://github.com/jcbrand/converse.js/blob/master/tests.html>`_
+and the `spec files <https://github.com/jcbrand/converse.js/blob/master/tests.html>`_
+to see how tests are implemented.
+
+Check that the tests pass
+~~~~~~~~~~~~~~~~~~~~~~~~~
+Check that all tests complete sucessfully.
+
+Run ``make check`` in your terminal or open `tests.html <https://github.com/jcbrand/converse.js/blob/master/tests.html>`_
+in your browser.