Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fixes dbc.RadioButton bug #214

Merged
merged 12 commits into from
May 6, 2022
46 changes: 46 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# Contributing

## Runnning tests offline

When submitting a PR github can run the full testsuite using github actions. For running the tests offline you
need to make sure you have installed all the required offline testing requirements:

### virtual environment

First create a new virtual environment:

`$ python -m venv venv`
`$ source venv/bin/activate`

### install dependencies and CLI tools

First make sure you have the latest version of pip itself:
`$ python -m pip install -U pip setuptools wheel`

Then install the whole package including dependencies:
`$ pip install -e .`

(this also install the CLI tools in the path)

### install testing dependencies

There are additional libraries such as selenium, xgboost, catboost, lightgbm etc needed for testing:

`$ pip install -r requirements_testing.txt`

(lightgbm may give some headaches when installing with pip, so can also `brew install lightgbm` instead)

### install chromedriver for integration tests

For the integration tests we use Selenium which launches a headless version of google chrome to launch a dashboard
in the browser and then checks that there are no error messages. In order to run these tests you need to download
a chromedriver that is compatible with your current installation of chrome at https://chromedriver.chromium.org/

You then unzip it and copy it to `$ cp chromedriver /usr/local/bin/chromedriver`
and on OSX allow it to be run with `$ xattr -d com.apple.quarantine /usr/local/bin/chromedriver`.

### running the tests

The tests should now run in the base directory with

`$ pytest .`
Loading