Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
78 lines (53 loc) · 1.83 KB

CONTRIBUTING.md

File metadata and controls

78 lines (53 loc) · 1.83 KB

Contributing to EventLens

Thank you for your interest in contributing! Here's how to get started.

Prerequisites

  • Java 21 (JDK with preview features)
  • Node.js 20 LTS (for the React UI)
  • Docker / Podman (for integration tests)

Building

./gradlew build

This compiles all modules, runs the React Vite build, and produces the fat JAR at: eventlens-app/build/libs/eventlens.jar

Running Tests

# Unit tests + contract tests
./gradlew test

# Full verification gate
./gradlew check

# Integration and contract tests (requires Docker/Podman for Testcontainers)
./gradlew test --info

Built-in plugins should keep passing the shared contract harness in eventlens-plugin-test.

For a compact v3 release smoke pass, run:

pwsh ./scripts/v3-release-smoke.ps1

Running Locally

# Start PostgreSQL + Kafka
docker compose up -d postgres kafka

# Run with the seed config
java --enable-preview -jar eventlens-app/build/libs/eventlens.jar serve

Code Style

  • Java 21 with preview features enabled
  • All public classes and methods must have Javadoc
  • Tests must use JUnit 5 + AssertJ
  • No System.out.println in server code — use SLF4J logging

Submitting a Pull Request

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/my-feature)
  3. Commit with descriptive messages
  4. Open a PR against main

Reporting Issues

Please open a GitHub Issue with:

  • EventLens version
  • Java version (java -version)
  • Steps to reproduce
  • Expected vs. actual behaviour

Plugin Development

  • Start with docs/plugin-authoring.md.
  • Reuse the shared contract harness from �ventlens-plugin-test for new source or stream plugins.
  • Register plugin entry points with META-INF/services/... so discovery works from classpath and /plugins.