CONTRIBUTING.md

Contributing guidelines (taken from Google Tensorflow project)

Contributing code

If you have improvements to Polymath15, send us your pull requests! For those just getting started, Github has a howto.

Polymath15 team members will be assigned to review your pull requests. Once the pull requests are approved, we will merge the pull requests.

Contribution guidelines and standards

Before sending your pull request for review, make sure your changes are consistent with the guidelines and follow the Polymath15 coding style.

General guidelines and philosophy for contribution

• We will develop more detailed guidelines as time passes.

Python coding style

Changes to Polymath15 Python code should conform to Google Python Style Guide

Use pylint to check your Python changes. To install pylint

pip install pylint

To check a file with pylint:

pylint --rcfile=pylintrc myfile.py

Coding style for other languages

• Google Java Style Guide
• Google JavaScript Style Guide
• Google Shell Style Guide
• Google Objective-C Style Guide

Running unit tests

All the tests are located in dbn_upper_bound/tests

To run python unit tests the command is

python -m unittest

You need to run this in the root folder