diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 000000000..3c48dedfa --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,26 @@ +# 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](https://github.com/QuickBlox/CodeStyle-Guidelines-for-Developers/tree/master/web). + +## Modify and build the library + +The quickblox.js library is build from a number of **CommonJS modules** contained in the `js` folder. For example the `js/modules/qbUsers.js` module contains the code that deals with the [Users API](http://quickblox.com/developers/Users). + +These modules are combined through [browserify](http://browserify.org/) into a single `quickblox.js` file in the root and so this is the only file that needs to be included in a `