xmpp.chapril.org-conversejs/.github/CONTRIBUTING.rst

38 lines
1.3 KiB
ReStructuredText
Raw Normal View History

2014-04-04 04:56:07 +02:00
=======================
Contribution Guidelines
=======================
2013-04-15 10:01:07 +02:00
Thanks for contributing to `Converse.js <https://conversejs.org>`_.
2013-04-17 12:11:59 +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
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
--------------------------------
2013-04-15 10:01:07 +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
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2013-04-17 12:11:59 +02:00
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.
2013-07-29 23:22:41 +02:00
Check that the tests pass
~~~~~~~~~~~~~~~~~~~~~~~~~
Check that all tests complete sucessfully.
2013-07-28 22:59:01 +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.