2014-04-04 04:56:07 +02:00
|
|
|
=======================
|
|
|
|
|
Contribution Guidelines
|
|
|
|
|
=======================
|
2013-04-15 10:01:07 +02:00
|
|
|
|
2014-03-22 01:03:34 +01:00
|
|
|
Thanks for contributing to `Converse.js <http://conversejs.org>`_.
|
2013-04-17 12:11:59 +02:00
|
|
|
|
2014-04-04 04:52:25 +02:00
|
|
|
Support questions
|
|
|
|
|
=================
|
|
|
|
|
Please ask support and setup questions on the mailing list: conversejs@librelist.com
|
2014-04-04 04:56:07 +02:00
|
|
|
|
2014-04-04 04:52:25 +02:00
|
|
|
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.
|
2013-04-15 10:01:07 +02:00
|
|
|
|
|
|
|
|
Before submitting a pull request
|
2014-04-04 04:52:25 +02:00
|
|
|
--------------------------------
|
2013-04-15 10:01:07 +02:00
|
|
|
|
2015-06-16 00:18:15 +02:00
|
|
|
Please read the `style guide <https://conversejs.org/docs/html/style_guide.html>`_ and make sure that your code follows it.
|
|
|
|
|
|
2013-04-15 10:01:07 +02:00
|
|
|
Add tests for your bugfix or feature
|
2014-04-04 04:52:25 +02:00
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
2013-04-17 12:11:59 +02:00
|
|
|
Add a test for any bug fixed or feature added. We use Jasmine
|
|
|
|
|
for testing.
|
|
|
|
|
|
2014-03-22 01:03:34 +01:00
|
|
|
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.
|
2013-07-28 22:51:25 +02:00
|
|
|
|
2013-07-29 23:22:41 +02:00
|
|
|
Check that the tests pass
|
2014-04-04 04:52:25 +02:00
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~
|
2015-06-16 00:18:15 +02:00
|
|
|
Check that all tests complete sucessfully.
|
2013-07-28 22:59:01 +02:00
|
|
|
|
2015-06-16 00:18:15 +02:00
|
|
|
Run ``make check`` in your terminal or open `tests.html <https://github.com/jcbrand/converse.js/blob/master/tests.html>`_
|
|
|
|
|
in your browser.
|
