Skip to main content

​
Getting Started

We welcome contributions! Here’s how to get started:
1

Fork the repository

Fork the repository on GitHub and clone your fork:
2

Set up development environment

Follow the Local Setup guide to get your environment running.
3

Create a branch

Create a feature branch:
4

Make your changes

Make your changes and test them locally.
5

Submit a pull request

Push your changes and open a pull request on GitHub.

​
Contribution Guidelines

​
Code Style

  • TypeScript/JavaScript: Follow existing code style
  • Rust: Follow Rust formatting standards (cargo fmt)
  • Commit messages: Use clear, descriptive messages

​
Testing

  • Write tests for new features
  • Ensure all existing tests pass
  • Test edge cases and error conditions

​
Documentation

  • Update documentation for new features
  • Add code comments for complex logic
  • Update README if needed

​
Areas for Contribution

​
High Priority

  • Bug fixes - Fix reported issues
  • Documentation - Improve docs
  • Tests - Increase test coverage
  • Performance - Optimize slow operations

​
Features

  • Detection algorithms - Improve threat detection
  • UI/UX - Enhance user experience
  • API features - Add new endpoints
  • Widget improvements - Enhance embeddable widget

​
Pull Request Process

  1. Update documentation if needed
  2. Add tests for new features
  3. Ensure tests pass locally
  4. Update CHANGELOG.md with your changes
  5. Submit PR with clear description

​
Code of Conduct

  • Be respectful and inclusive
  • Welcome newcomers
  • Focus on constructive feedback
  • Help others learn and grow

​
Questions?

Local Setup

Set up your development environment.

GitHub Issues

Report bugs or request features.

Contact

Reach out for help.