bigbio / sdrf-pipelines

A repository to convert SDRF proteomics files into pipelines config files
Apache License 2.0
16 stars 21 forks source link

[DOC] Document how to run tests #102

Open fabianegli opened 2 years ago

fabianegli commented 2 years ago

Developers need to run tests locally and it would be nice to have documentation about how to run the tests in this repo during package development.

fabianegli commented 2 years ago

Ideally a pre-commit hook would be provided.

I was two types of tests in the CI, one integration test that converts a file and looks if the converted file matches the expected file and one that runs the tests in sdrf_pipelines/tests/sdrfchecker_tests.py. pythonapp.yml and pythonpackage.yml seem to be mostly identical and not to be active, i.e. not running upon push/merge.

ypriverol commented 2 years ago

This is also a really nice first task. Also, if we want to involve more developers in the project in the future and for us to come back every time is easier to have a better set of tests. 👍