Contributing

Thanks for considering making an addition to this project! These contributing guidelines should help make your life easier.

Before starting, some things to consider:

For larger features, it would be helpful to get in touch first (through issue/email)
A lot of the logic is in docdeid, please consider making a PR there for things that are not specific to deduce.
deduce is a rule-based de-identifier
In case you would like to see any rules added/removed/changed, a decent substantiation (with examples) of the potential improvement is useful

Setting up the environment

This project uses poetry for package management. Install it with pip install poetry
Set up the environment is easy, just use poetry install
The makefile contains some useful commands when developing:
- make format formats the package code
- make lint runs the linters (check the output)
- make clean removes build/test artifacts, etc
And for docs:
- make build-docs builds the docs

pytest .

If all the steps above are followed, this ensures a quick review and release of your contribution.

Readthedocs has a webhook connected to pushes on the main branch. It will trigger and update automatically.
Create a release on github, create a tag with the right version, manually copy and paste from the changelog
Build pipeline and release to PyPi trigger automatically on release

Any other questions/issues not covered here? Please just get in touch!