Skip to content

Contributing

Ahmed edited this page Mar 16, 2026 · 2 revisions

Contributing

We welcome contributions to EventLens! Please review our Code of Conduct before making a PR.

Getting Started

  1. Fork the codebase on GitHub.
  2. Ensure you have JDK 21+ and Node.js 18+ installed.
  3. Start the developmental data layers: docker-compose up -d (starts Postgres and Kafka).
  4. Build the core: ./gradlew build.

Pull Request Guidelines

  • All integration and unit tests must pass.
  • New code should maintain or improve coverage.
  • Write a descriptive PR title summarizing what is being fixed or improved.
  • Ensure the React UI complies with ESLint and Prettier configs in the eventlens-ui folder.

Return Home

Clone this wiki locally