Bug reports
A good bug report saves time for everyone. Before opening an issue, a few quick checks.
Before opening an issue
- Check the version: reproduce on the latest release (
pip install -U piighostoruv lock --upgrade-package piighost). - Search existing issues: open and closed issues.
- Isolate the problem: does the bug happen with
ExactMatchDetector(which loads no NER model) or only with the NER detector? The difference helps locate the cause.
What a good report contains
What to avoid
- High-level reports like "de-identification doesn't work" without a reproducible example.
- Screenshots of code instead of a text block (cannot be copy-pasted to reproduce).
- Sharing real confidential data in the issue. Use fake values (
Alice Smith,Paris,alice@example.com).
Security vulnerabilities
Do not open a public issue for a vulnerability. Use the private GitHub advisory reporting channel. See Security for the threat model and what piighost does or does not protect against.