Pārlūkot izejas kodu

Update CONTRIBUTING

JC Brand 3 gadi atpakaļ
vecāks
revīzija
c3e3f89e52
2 mainītis faili ar 28 papildinājumiem un 37 dzēšanām
  1. 28 0
      .github/CONTRIBUTING.md
  2. 0 37
      .github/CONTRIBUTING.rst

+ 28 - 0
.github/CONTRIBUTING.md

@@ -0,0 +1,28 @@
+# Contribution Guidelines
+
+Thanks for contributing to [Converse.js](https://conversejs.org)
+
+## Support questions
+
+The Github issue tracker is used for bugs reports and feature requests, not for general tech support.
+
+For support, you can join your [XMPP webchat](https://inverse.chat/#converse/room?jid=discuss@conference.conversejs.org).
+Instead of the webchat, you can also open the room in your XMPP client, [click here](xmpp://discuss@conference.conversejs.org?join).
+
+You can also ask questions on [StackOverflow](https://stackoverflow.com/questions/tagged/converse.js)
+
+## Contributing Code
+
+Please follow the usual Github workflow. Create a fork of this repository, make your changes and then submit a pull request.
+
+### Before submitting a pull request
+
+Please read the `style guide <https://conversejs.org/docs/html/style_guide.html>`_ and make sure that your code follows it.
+
+### Add tests for your bugfix or feature
+
+Add a test for any bug fixed or feature added.
+
+Tests are can be find in various `./test` folders in the Converse source code.
+
+To run the tests, you can run `make check` on Linux and Mac, or `./node_modules/bin/karma start karma.conf` on Windows.

+ 0 - 37
.github/CONTRIBUTING.rst

@@ -1,37 +0,0 @@
-=======================
-Contribution Guidelines
-=======================
-
-Thanks for contributing to `Converse.js <https://conversejs.org>`_.
-
-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
---------------------------------
-
-Please read the `style guide <https://conversejs.org/docs/html/style_guide.html>`_ and make sure that your code follows it.
-
-Add tests for your bugfix or feature
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-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.
-
-Check that the tests pass
-~~~~~~~~~~~~~~~~~~~~~~~~~
-Check that all tests complete sucessfully.
-
-Run ``make check`` in your terminal or open `tests.html <https://github.com/jcbrand/converse.js/blob/master/tests.html>`_
-in your browser.