1 =======================
2 Contribution Guidelines
3 =======================
5 Thanks for contributing to `Converse.js <http://conversejs.org>`_.
9 Please ask support and setup questions on the mailing list: conversejs@librelist.com
11 The issue tracker is only for bugs (i.e. issues) and feature requests.
15 Please follow the usual github workflow. Create your own local fork of this repository,
16 make your changes and then submit a pull request.
18 Before submitting a pull request
19 --------------------------------
21 Please read the `style guide <https://conversejs.org/docs/html/style_guide.html>`_ and make sure that your code follows it.
23 Add tests for your bugfix or feature
24 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
25 Add a test for any bug fixed or feature added. We use Jasmine
28 Take a look at `tests.html <https://github.com/jcbrand/converse.js/blob/master/tests.html>`_
29 and the `spec files <https://github.com/jcbrand/converse.js/blob/master/tests.html>`_
30 to see how tests are implemented.
32 Check that the tests pass
33 ~~~~~~~~~~~~~~~~~~~~~~~~~
34 Check that all tests complete sucessfully.
36 Run ``make check`` in your terminal or open `tests.html <https://github.com/jcbrand/converse.js/blob/master/tests.html>`_