diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 021d2eb31..cdc094db6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,11 +9,15 @@ Contribution examples: If you could kindly send a PR to ChainerRL, please make sure all the tests successfully pass. +When contributing to ChainerRL, we highly recommend installing the additional set of developer requirements, which may be necessary for testing: +``` +pip install -r requirements-dev.txt +``` + ## Testing -To test chainerrl modules, install and run `pytest`. Pass `-m "not gpu"` to skip tests that require gpu. E.g. +To test chainerrl modules, install and run `pytest` (after installing `pytest`). Pass `-m "not gpu"` to skip tests that require gpu. E.g. ``` -$ pip install pytest $ pytest -m "not gpu" ```
Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.
Alternative Proxies: