Skip to content

Latest commit

 

History

History
38 lines (26 loc) · 670 Bytes

CONTRTIBUTING.md

File metadata and controls

38 lines (26 loc) · 670 Bytes
Raw

How to contribute

Install

  • fork the repository
  • clone your fork
git clone https://github.com/YOUR_GITHUB_USERNAME/eye2bids.git
  • install the package in editable mode with all its development dependencies
cd eye2bids
pip install -e '.[dev]'

Test

To run the tests, you need to install the test data from OSF by running the following command:

python tools/download_test_data.py

You can then run any test by using pytest

python -m pytest tests/path_to_test_file.py::function_to_run

For example:

python -m pytest tests/test_edf2bids.py::test_convert_edf_to_asc_events