xmpp/converse/CONTRIBUTING.rst

   1 =======================
   2 Contribution Guidelines
   3 =======================
   4
   5 Thanks for contributing to `Converse.js <http://conversejs.org>`_.
   6
   7 Support questions
   8 =================
   9 Please ask support and setup questions on the mailing list: conversejs@librelist.com
  10
  11 The issue tracker is only for bugs (i.e. issues) and feature requests.
  12
  13 Contributing Code
  14 =================
  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.
  17
  18 Before submitting a pull request
  19 --------------------------------
  20
  21 Please read the `style guide <https://conversejs.org/docs/html/style_guide.html>`_ and make sure that your code follows it.
  22
  23 Add tests for your bugfix or feature
  24 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  25 Add a test for any bug fixed or feature added. We use Jasmine
  26 for testing.
  27
  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.
  31
  32 Check that the tests pass
  33 ~~~~~~~~~~~~~~~~~~~~~~~~~
  34 Check that all tests complete sucessfully.
  35
  36 Run ``make check`` in your terminal or open `tests.html <https://github.com/jcbrand/converse.js/blob/master/tests.html>`_
  37 in your browser.