2013-04-15 10:01:07 +02:00
|
|
|
===========================
|
|
|
|
|
Contributing to Converse.js
|
|
|
|
|
===========================
|
|
|
|
|
|
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-03-22 01:03:34 +01:00
|
|
|
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
|
|
|
|
|
================================
|
|
|
|
|
|
|
|
|
|
Add tests for your bugfix or feature
|
|
|
|
|
------------------------------------
|
|
|
|
|
|
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
|
|
|
|
|
-------------------------
|
2013-04-15 10:01:07 +02:00
|
|
|
|
2014-03-22 01:03:34 +01:00
|
|
|
Check that the Jasmine tests complete sucessfully. Open
|
|
|
|
|
`tests.html <https://github.com/jcbrand/converse.js/blob/master/tests.html>`_
|
|
|
|
|
in your browser, and the tests will run automatically.
|
2013-07-28 22:51:25 +02:00
|
|
|
|
2013-07-28 22:59:01 +02:00
|
|
|
Check your code for errors or bad habits by running JSHint
|
|
|
|
|
----------------------------------------------------------
|
|
|
|
|
|
2014-03-22 01:03:34 +01:00
|
|
|
Run ``grunt jshint`` and check the output.
|
