Skip to content

Latest commit

 

History

History
44 lines (35 loc) · 1.13 KB

CONTRIBUTING.md

File metadata and controls

44 lines (35 loc) · 1.13 KB

Contributing to d3rlpy

Any kind of contribution to d3rlpy 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

Development Guide

Build from source

$ git clone [email protected]:takuseno/d3rlpy
$ cd d3rlpy
$ pip install -e .

Before making your nice PR, please run the follwing commands to inspect code qualities.

Install additional dependencies for development

$ pip install -r dev.requirements.txt

Testing

$ ./scripts/test

Coding style check

This repository is styled with black formatter. Also, isort is used to format package imports. docformatter is additionally used to format docstrings.

$ ./scripts/format

Linter

This repository is fully type-annotated and checked by mypy. Also, pylint checks code consistency.

$ ./scripts/lint