49 lines (32 loc) · 1010 Bytes

Contributing to haveibeenfiltered

Thanks for your interest in contributing!

Reporting Issues

Use GitHub Issues
Include Node.js version, OS, and steps to reproduce
For security vulnerabilities, email mihail@fedorov.net directly

Development

git clone https://github.com/kolobus/haveibeenfiltered.git
cd haveibeenfiltered

No install step needed — zero dependencies.

Testing

Download a test filter first:

node bin/cli.js download --dataset rockyou

Then run the test suite:

npm test

Code Style

No external dependencies — Node.js builtins only
No transpilation — plain CommonJS
Keep it simple — this is a focused library

Pull Requests

Fork the repo and create your branch from main
Add tests if you've added code
Ensure npm test passes
Submit your PR

License

By contributing, you agree that your contributions will be licensed under the MIT License.