From fa338c48288057d449840bec4d51219f5a1f2e99 Mon Sep 17 00:00:00 2001 From: JC Brand Date: Wed, 2 Nov 2016 15:08:03 +0100 Subject: [PATCH] Provide a brief explanation of converse.js's dependencies. --- docs/source/developer_guidelines.rst | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/docs/source/developer_guidelines.rst b/docs/source/developer_guidelines.rst index 3bece906b..602321fe9 100644 --- a/docs/source/developer_guidelines.rst +++ b/docs/source/developer_guidelines.rst @@ -95,9 +95,27 @@ to use it this way, please refer to for an example of how and in what order all the Javascript files that converse.js depends on need to be loaded. +Brief description of converse.js's dependencies +----------------------------------------------- -Before submitting a pull request --------------------------------- +Converse.js relies on the following dependencies: + +* [JQuery](http://jquery.com/) for DOM manipulation and [promises](http://api.jquery.com/promise/). +* [moment.js](http://momentjs.com/) provides a better API for handling dates and times. +* [Strophe.js](http://strophe.im/) maintains the XMPP session, is used to + build XMPP stanzas, to send them, and to register handlers for received stanzas. +* [Underscore](http://underscorejs.org/) provides very useful utility functions. +* [Backbone](http://backbonejs.org/) is used to model the data as Models and + Collections and to create Views that render the UI. +* [backbone.overview](http://github.com/jcbrand/backbone.overview) provides + Overviews, which are to Views as Backbone Collections are to Models. +* [pluggable.js](https://github.com/jcbrand/pluggable.js) is the plugin + architecture for Converse.js. It registers and initializes plugins and + allows existing attributes, functions and objects on converse.js to be + overridden inside plugins. + +When submitting a pull request +------------------------------ Please follow the usual github workflow. Create your own local fork of this repository, make your changes and then submit a pull request.