From 9313240a37776c01ed205b5665b88035c9f66080 Mon Sep 17 00:00:00 2001 From: aiueola Date: Wed, 31 May 2023 14:47:54 +0900 Subject: [PATCH] minor fix --- CONTRIBUTING.md | 45 +++++++++++++++++++++++++++++++++++++++++++++ README.md | 2 +- 2 files changed, 46 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e69de29b..5c1fe36c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -0,0 +1,45 @@ +## Contribution Guidelines +First off, thanks for your interest to cotribute to SCOPE-RL! + +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 for Reinforcement Learning together! + +We prepare some conventions as follows: + +- [Coding Guidelines](#coding-guidelines) +- [Tests](#tests) +- [Continuous Integration](#continuous-integration) + +## Coding Guidelines + +Code is formatted with [black](https://github.com/psf/black), +and coding style is checked with [flake8](http://flake8.pycqa.org). + +After installing black, you can perform code formatting by the following command: + +```bash +# perform formatting recursively for the files under the current dir +$ black . +``` + +After installing flake8, you can check the coding style by the following command: + +```bash +# perform checking of the coding style +$ flake8 . +``` + +## Tests + +We are currently working on implementing unit testing using pytest as the testing framework. We greatly appreciate any helps for adding the test codes. If you are interested in working on the test codes, please contact: hk844@cornell.edu + + +```bash +# perform all the tests under the tests directory +$ pytest . +``` + +## Continuous Integration + +SCOPE-RL uses Github Actions to perform continuous integration. \ No newline at end of file diff --git a/README.md b/README.md index 615fafa4..2b4e4dac 100644 --- a/README.md +++ b/README.md @@ -127,7 +127,7 @@ cd scope-rl python setup.py install ``` -SCOPE-RL supports Python 3.7 or newer. See [pyproject.toml](./pyproject.toml) for other requirements. +SCOPE-RL supports Python 3.7 or newer. See [requirements.txt](./requirements.txt) for other requirements. ## Usage