Skip to content

Latest commit

 

History

History
44 lines (28 loc) · 918 Bytes

CONTRIBUTING.md

File metadata and controls

44 lines (28 loc) · 918 Bytes

Getting started

Requirements are listed in setup.cfg and can be installed with

pip install [--user] .[dev]

Make a contribution

Before making a merge request make sure the following is done on your branch

  1. Update HDF5 repository examples
  2. Linting
  3. Testing

Update HDF5 repository examples

To be sure all HDF5 files are compliant with the latest standard

pip install -e .[dev]
./converted/generate.sh

Linting

The configuration for black and flake8 can be modified in setup.cfg.

Comment lines with # noqa: E123 to ignore certain linting errors.

Testing

Tests make use pytest and can be run as follows

pytest .

Testing an installed project is done like this

pytest --pyargs <project_name>