Contributing to GSC-client

Coding style

GSC-client follows Google's JavaScript Style Guide. We are using jshint to check the code for any bugs or errors and jscs to enforce the coding style. The style guides are stored in two files on the root folder, .jshintrc (used by jshint) and google.json (used by jscs). Jscs is configured to autofix code style violations when possible.

Building the code are done using grunt and all the project configuration are stored in gruntfile.js on the project root folder.

To build the entire project simply write

grunt

To check for any bugs write

grunt jshint:dev

To check for styling errors write

grunt jscs

Text editor

If possible, configure your editor to follow the coding conventions of the library. Sublime may be set up to automatically run lint on save.

Make sure your client are using two spaces as indentation.