Contributing
Thanks for your interest in contributing to the Python Record Linkage Toolkit. There is a lot of work to do. See Github for the contributors to this package.
The workflow for contributing is as follows:
Make a branch with your modifications/contributions
Write tests
Run all tests
Do a pull request
Testing
Install pytest:
pip install pytest
Run the following command to test the package
python -m pytest tests/
Performance
Performance is very important in record linkage. The performance is monitored for all serious modifications of the core API. The performance monitoring is performed with Airspeed Velocity (asv).
Install Airspeed Velocity:
pip install asv
Run the following command from the root of the repository to test the performance of the current version of the package:
asv run
Run the following command to test all versions since tag v0.6.0
asv run --skip-existing-commits v0.6.0..master