CONTRIBUTING.md

Contributing

Thanks for helping improve Patchrank.

Local Checks

python -m unittest discover -s tests
PYTHONPATH=src python -m patchrank rank examples/trivy.json --kev examples/kev.json --epss examples/epss.json

PowerShell:

$env:PYTHONPATH = "src"
python -m unittest discover -s tests
python -m patchrank rank examples/trivy.json --kev examples/kev.json --epss examples/epss.json

Guidelines

• Keep runtime dependencies minimal.
• Add tests for each parser or scoring change.
• Keep scoring explainable; every score boost should have a reason string.
• Do not commit private vulnerability reports, tokens, or customer data.
• Prefer fixtures with synthetic package names and public CVE IDs.