Skip to content

Latest commit

 

History

History
25 lines (19 loc) · 1.42 KB

CONTRIBUTING.md

File metadata and controls

25 lines (19 loc) · 1.42 KB
Raw

How to contribute

First off, thanks that you help us to make Quickblox better. Feedback and suggestions for improvement always welcome :)

Coding conventions

Please follow all rules from our code style guidelines.

Modify and build the library

The quickblox.min.js library is build from a number of CommonJS modules contained in the src folder. For example the src/modules/qbUsers.js module contains the code that deals with the Users API.

These modules are combined through browserify into a single quickblox.min.js file in the root and so this is the only file that needs to be included in a <script> tag OR in a RequireJS application OR in Node.js environment (everywhere). To build the library, uses gulp task runner.

  • You need to have the dependencies listed in the package.json available, use npm install to load them;
  • Install gulp and globally;
  • Install jasmine globally;
  • Change the 'version' properties in next files:
    • ./bower.json;
    • ./package.json;
    • ./src/qbConfig.js;
  • Rebuild SDK: npm run build, check tests in node / browser env.
  • Update ./README.md;
  • Make a pull request into gh-pages;