Skip to content

Latest commit

 

History

History
35 lines (26 loc) · 1.14 KB

CONTRIBUTING.md

File metadata and controls

35 lines (26 loc) · 1.14 KB
Raw

Contributing to ChainerRL

Any kind of contribution to ChainerRL would be highly appreciated!

Contribution examples:

  • Thumbing up to good issues or pull requests 👍
  • Opening issues about questions, bugs, installation problems, feature requests, algorithm requests etc.
  • Sending pull requests

If you could kindly send a PR to ChainerRL, please make sure all the tests successfully pass.

Testing

To test chainerrl modules, install nose and run nosetests. Pass -a '!gpu' to skip tests that require gpu.

To test examples, run test_examples.sh [gpu device id]. -1 would run examples with only cpu.

Coding style

We use PEP8. To check your code, use flake8 command installed by hacking package.

$ pip install hacking
$ flake8 path/to/your/code.py

To use Python 3 features as much as possible while keeping Python 2 support, add the following lines to the head of each file.

from __future__ import print_function
from __future__ import unicode_literals
from __future__ import division
from __future__ import absolute_import
from builtins import *  # NOQA
from future import standard_library
standard_library.install_aliases()