CONTRIBUTING.md

Contributing

Thanks for helping improve IOCraft.

Local Checks

python -m unittest discover -s tests
PYTHONPATH=src python -m iocraft extract examples/report.txt --format markdown --defang-output

PowerShell:

$env:PYTHONPATH = "src"
python -m unittest discover -s tests
python -m iocraft extract examples/report.txt --format markdown --defang-output

Guidelines

• Keep runtime dependencies at zero unless a feature clearly needs one.
• Add tests for every extractor, normalizer, and output behavior change.
• Avoid fixtures that include real private incident data.
• Prefer small, explainable parsing heuristics over opaque extraction behavior.
• Keep output deterministic so analysts can diff results.