Skip to content

Latest commit

 

History

History
42 lines (34 loc) · 1.2 KB

CONTRIBUTING.md

File metadata and controls

42 lines (34 loc) · 1.2 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.

testing

$ pip install pytest-cov onnxruntime onnx # dependencies used in unit tests
$ ./scripts/test

coding style

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

$ pip install black isort docformatter # formatters
$ ./scripts/format

linter

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

$ pip install mypy pylint==2.13.5 # linters
$ ./scripts/lint