CONTRIBUTING.md

Contributing

For Crawler and Classifier

We are following Google Python Style Guide. To make sure that we adhere to this style guide, we use YAPF to reformat our Python codes.

# Install YAPF using pip
pip install yapf

# Run the formatter
# The configuration file is located at ./.style.yapf
yapf -r -i crawler/

For UI

We are following Google Javascript Style Guide for Javascript files under the directory ./UI/js. We use ESLint to lint our codes. To use ESLint, we first install the tool by using the following commands:

$ cd UI
$ npm install -g eslint eslint-config-defaults

Next, we run the tool using the following command:

$ eslint js/custom.js

Alternatively, if you are using Sublime Text 3, you can install SublimeLinter and SublimeLinter-eslint.