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

29 lines
1.1 KiB
Markdown
Raw Permalink Normal View History

2022-04-07 14:21:51 +02:00
# Contribution Guidelines
Thanks for contributing to [Converse.js](https://conversejs.org)
## Support questions
2022-07-06 12:22:29 +02:00
The Github issue tracker is used for bug reports and feature requests, not for general tech support.
2022-04-07 14:21:51 +02:00
2022-07-06 12:22:29 +02:00
For support, you can join our [XMPP webchat](https://inverse.chat/#converse/room?jid=discuss@conference.conversejs.org).
2022-04-07 14:21:51 +02:00
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.
2022-04-07 14:21:51 +02:00
### Add tests for your bugfix or feature
Add a test for any bug fixed or feature added.
2022-07-11 13:10:57 +02:00
Tests can be found in various `./tests` folders in the Converse source code.
2022-04-07 14:21:51 +02:00
To run the tests, you can run `make check` on Linux and Mac, or `./node_modules/bin/karma start karma.conf` on Windows.