SECTION / CONTRIBUTING

Contributing

flokbn is an open-source IP clustering tool that welcomes contributions from the community. Whether you’re fixing bugs, adding features, improving documentation, or optimizing performance, your help is appreciated.

Ways to Contribute

  • Code: Implement new features, fix bugs, or optimize performance
  • Documentation: Improve guides, add examples, or fix typos
  • Testing: Write tests, report bugs, or verify fixes
  • Ideas: Suggest features or improvements in GitHub Discussions

Core Principles

  1. Performance First: flokbn processes millions of log entries - speed matters
  2. Test Everything: All code changes require tests
  3. Keep It Simple: Avoid over-engineering
  4. Document Changes: Help others understand your work