Skip to content

Commit e25300f

Browse files
dimaspiritsoulfly
authored andcommitted
add github helpers files (#134)
Updated GitHub repo meta data
1 parent a596c8f commit e25300f

File tree

4 files changed

+62
-18
lines changed

4 files changed

+62
-18
lines changed

.github/CONTRIBUTING.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# How to contribute
2+
3+
First off, thanks that you help us to make Quickblox better.
4+
Feedback and suggestions for improvement always welcome :)
5+
6+
## Coding conventions
7+
Please follow all rules from our [code style guidelines](https://github.com/QuickBlox/CodeStyle-Guidelines-for-Developers/tree/master/web).
8+
9+
## Modify and build the library
10+
11+
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).
12+
13+
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.
14+
15+
* You need to have the dependencies listed in the package.json available, use `npm install` to load them;
16+
* Install **grunt-cli** `npm install -g grunt-cli`;
17+
* Also you need install **jasmine** global `npm i -g jasmine` for tests;
18+
* Change the 'version' properties in next files:
19+
* https://github.com/QuickBlox/quickblox-javascript-sdk/blob/gh-pages/js/qbConfig.js;
20+
* https://github.com/QuickBlox/quickblox-javascript-sdk/blob/gh-pages/bower.json;
21+
* https://github.com/QuickBlox/quickblox-javascript-sdk/blob/gh-pages/package.json;
22+
* Rebuild SDK: `grunt`;
23+
* Update README.md;
24+
* 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;
25+
* `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);
26+
* Update QuickBlox developers section.

.github/ISSUE_TEMPLATE.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
*Help avoid duplicate issue reports, check [existing issues](https://github.com/QuickBlox/quickblox-javascript-sdk/issues)*
2+
3+
**Environment details**
4+
*(Operating system, browser information, SDK version)*
5+
6+
7+
**Did this work before?**
8+
9+
10+
**Expected behavior**
11+
12+
13+
**Actual behavior**
14+
15+
16+
**Logs**
17+
*(please, switch on a [debugging mode](http://quickblox.com/developers/Javascript#Configuration) and share us outputs uses github [gist](https://gist.github.com/))*
18+
19+
20+
**Steps to reproduce the behavior**
21+
22+
23+
**Any others comments?**

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
*Make sure that you wrote the tests for your proposed changes and the existing test was success.*
2+
3+
**Made/Proposed changes:**
4+
*(Don’t use general words, describe changes in details)*
5+
-
6+
-
7+
8+
**How should this be manually tested?**
9+
10+
11+
**Does the documentation need an update?**

README.md

Lines changed: 2 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -72,24 +72,8 @@ Please raise questions, requests for help etc. via http://stackoverflow.com/ques
7272

7373
Feedback and suggestions for improvement always welcome :)
7474

75-
# Modifying and building the library
76-
77-
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).
78-
79-
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:
80-
81-
* You need to have the dependencies listed in the package.json available, use `npm install` to load them.
82-
* Install **grunt-cli** `npm install -g grunt-cli`
83-
* Also you need install **jasmine** global `npm i -g jasmine` for tests.
84-
* Change the 'version' properties in next files:
85-
* https://github.com/QuickBlox/quickblox-javascript-sdk/blob/gh-pages/js/qbConfig.js
86-
* https://github.com/QuickBlox/quickblox-javascript-sdk/blob/gh-pages/bower.json
87-
* https://github.com/QuickBlox/quickblox-javascript-sdk/blob/gh-pages/package.json
88-
* Rebuild SDK: `grunt`
89-
* Update README.md
90-
* 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.
91-
* `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)
92-
* Update QuickBlox developers section
75+
# How to contribute
76+
See more information at [contributing.md](https://github.com/QuickBlox/quickblox-javascript-sdk/blob/gh-pages/.github/CONTRIBUTING.md)
9377

9478
# License
9579
BSD

0 commit comments

Comments
 (0)