Chapril/xmpp.chapril.org-conversejs
Chapril/xmpp.chapril.org-conversejs
24
0
Fork 0
Code Issues Pull Requests Projects Releases Activity

Update contribution guidelines to mention mailing list

Browse Source 
Conflicts:
	CONTRIBUTING.rst
This commit is contained in:
JC Brand 2014-04-04 04:52:25 +02:00
parent df599238f8
commit ce7a3b3ff5
1 changed files with 13 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
CONTRIBUTING.rst
View File

@ -4,14 +4,21 @@ Contributing to Converse.js
Thanks for contributing to `Converse.js <http://conversejs.org>`_.
Please follow the usual github workflow. Create your own local fork of this
repository, make your changes and then submit a pull request.
Support questions
=================
Please ask support and setup questions on the mailing list: conversejs@librelist.com
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.
Before submitting a pull request
================================
--------------------------------
Add tests for your bugfix or feature
------------------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Add a test for any bug fixed or feature added. We use Jasmine
for testing.
@ -21,13 +28,13 @@ and the `spec files <https://github.com/jcbrand/converse.js/blob/master/tests.ht
to see how tests are implemented.
Check that the tests pass
-------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~
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.
Check your code for errors or bad habits by running JSHint
----------------------------------------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Run ``grunt jshint`` and check the output.