41 lines (26 loc) · 1.49 KB

Contributing

Your contributions are very much appreciated! If you want to work on this tool, we recommend you do the following:

Set up a virtual environment in this directory.
Install this project within itself in editable mode: pip install -e .
Install the dev requirements: pip install -r requirements-tests.txt

If you also have a decompilation project, we recommend the following:

Set up a separate virtual environment in your decompilation project.
Inside that virtual environment, pip install -e path/to/your/local/reccmp/repository.

This way, you can easily run your latest reccmp changes against your decompilation project.

Testing

This project comes with a suite of tests based on pytest. Most of them can be run out of the box:

pytest .

The remaining tests depend on existing original binary files, specifically:

LEGO1.DLL from LEGO Island (English, v1.1), see e.g. https://www.legoisland.org/wiki/LEGO_Island#Download.
SKI.EXE from SkiFree (16 bit), see e.g. isledecomp#90.

It is recommended to place the original binaries under tests/binfiles. Alternatively, you can specify their directory as follows:

pytest . --binfiles=/path/to/the/binfiles

Linting and formatting

In order to keep the Python code clean and consistent, we use pylint and black:

Run pylint: pylint reccmp
Check formatting without making changes: black --check reccmp
Apply formatting: black reccmp