Skip to content

Latest commit

 

History

History
44 lines (30 loc) · 1.17 KB

CONTRIBUTING.md

File metadata and controls

44 lines (30 loc) · 1.17 KB

Contribution Guidelines

First off, thanks for your interest!

We are doing our best to make this project even better. However, we recognize that there is ample room for improvement. We need your help to make this project even better. Let's make the best Off-Policy Evaluation software together!

We prepare some conventions as follows:

Coding Guidelines

Code is formatted with black, and coding style is checked with flake8.

After installing black, you can perform code formatting by the following command:

# perform formatting recursively for the files under the current dir
$ black .

After installing flake8, you can check the coding style by the following command:

# perform checking of the coding style
$ flake8 .

Tests

We employ pytest as the testing framework. You can run all the tests as follows:

# perform all the tests under the tests directory
$ pytest .

Continuous Integration

Open Bandit Pipeline uses Github Actions to perform continuous integration.