Skip to content

add github helpers files #134

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Apr 26, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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 `<script>` tag OR in a RequireJS application OR in Node.js environment (everywhere). To build the library, use the [Grunt](http://gruntjs.com/) task runner.

* You need to have the dependencies listed in the package.json available, use `npm install` to load them;
* Install **grunt-cli** `npm install -g grunt-cli`;
* Also you need install **jasmine** global `npm i -g jasmine` for tests;
* Change the 'version' properties in next files:
* https://github.com/QuickBlox/quickblox-javascript-sdk/blob/gh-pages/js/qbConfig.js;
* https://github.com/QuickBlox/quickblox-javascript-sdk/blob/gh-pages/bower.json;
* https://github.com/QuickBlox/quickblox-javascript-sdk/blob/gh-pages/package.json;
* Rebuild SDK: `grunt`;
* Update README.md;
* Commit your changes to git repository and create a new "git tag" for new version. This action updates SDK for GIT and also for bower package manager;
* `npm publish`. This action updates SDK for node package manager, but maybe you will be needed some author credentials for it (you should be in owner list);
* Update QuickBlox developers section.
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
*Help avoid duplicate issue reports, check [existing issues](https://github.com/QuickBlox/quickblox-javascript-sdk/issues)*

**Environment details**
*(Operating system, browser information, SDK version)*


**Did this work before?**


**Expected behavior**


**Actual behavior**


**Logs**
*(please, switch on a [debugging mode](http://quickblox.com/developers/Javascript#Configuration) and share us outputs uses github [gist](https://gist.github.com/))*


**Steps to reproduce the behavior**


**Any others comments?**
11 changes: 11 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
*Make sure that you wrote the tests for your proposed changes and the existing test was success.*

**Made/Proposed changes:**
*(Don’t use general words, describe changes in details)*
-
-

**How should this be manually tested?**


**Does the documentation need an update?**
20 changes: 2 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,24 +72,8 @@ Please raise questions, requests for help etc. via http://stackoverflow.com/ques

Feedback and suggestions for improvement always welcome :)

# Modifying and building 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 `<script>` tag OR in a RequireJS application OR in Node.js environment (everywhere). To build the library, use the [Grunt](http://gruntjs.com/) task runner:

* You need to have the dependencies listed in the package.json available, use `npm install` to load them.
* Install **grunt-cli** `npm install -g grunt-cli`
* Also you need install **jasmine** global `npm i -g jasmine` for tests.
* Change the 'version' properties in next files:
* https://github.com/QuickBlox/quickblox-javascript-sdk/blob/gh-pages/js/qbConfig.js
* https://github.com/QuickBlox/quickblox-javascript-sdk/blob/gh-pages/bower.json
* https://github.com/QuickBlox/quickblox-javascript-sdk/blob/gh-pages/package.json
* Rebuild SDK: `grunt`
* Update README.md
* Commit your changes to git repository and create a new "git tag" for new version. This action updates SDK for GIT and also for bower package manager.
* `npm publish`. This action updates SDK for node package manager, but maybe you will be needed some author credentials for it (you should be in owner list)
* Update QuickBlox developers section
# How to contribute
See more information at [contributing.md](https://github.com/QuickBlox/quickblox-javascript-sdk/blob/gh-pages/.github/CONTRIBUTING.md)

# License
BSD