Community

Get involved with the Jikkou community — contribute code or docs, build Jikkou from source, and find blog posts, talks, and other resources.

1: Building from Source

2: Resources

3: Contribution Guidelines

Jikkou is an open-source project. This section explains how to contribute, how to build Jikkou from source, and where to find community resources such as blog posts and talks.

Contribution Guidelines — how to report issues and submit pull requests.
Building from Source — set up your environment to build and test Jikkou itself.
Resources — blog posts, guides, and talks about GitOps for Apache Kafka with Jikkou.

1 - Building from Source

How to set up your environment to build and test Jikkou itself.

This guide is for contributors who want to build and test the Jikkou project itself. If you are looking to develop your own Jikkou extensions or use the Java API, see the Developer Guide instead.

Prerequisites

Java 25 (see https://sdkman.io/ for installing java locally)
Git
Docker and Docker-Compose
Your favorite IDE

Building Jikkou

We use Maven Wrapper to build our project. The simplest way to get started is:

For building distribution files.

$ ./mvnw clean package -Pdist -DskipTests

Alternatively, we also use Make to package and build the Docker image for Jikkou:

$ make

Running tests

For running all tests and checks:

$ ./mvnw clean verify

Code Format

This project uses the Maven plugin Spotless to format all Java classes and to apply some code quality checks.

Bugs & Security

This project uses the Maven plugin SpotBugs and FindSecBugs to run some static analysis to look for bugs in Java code.

Reported bugs can be analysed using SpotBugs GUI:

$ ./mvnw spotbugs:gui

2 - Resources

Community resources including blog posts, guides, and talks about GitOps for Apache Kafka with Jikkou.

Blog

Gitops for Kafka in the real world: How we governed 78 clusters without breaking production (by Harshwardhan Mehrotra, One2N)
GitOps & Kafka: Enabling smooth and seamless Data Schema management with Jikkou and GitHub Actions (by Florian Hussonnois)
Jikkou: Declarative ACLs configuration for Apache Kafka® and Schema Registry on Aiven (by Florian Hussonnois)
Kafka Connect + Jikkou- Easily manage Kafka connectors (by Florian Hussonnois)
Why is Managing Kafka Topics Still Such a Pain? Introducing Jikkou! (Florian Hussonnois)

3 - Contribution Guidelines

How to contribute to Jikkou

Jikkou is an open source project, and we love getting patches and contributions to make Jikkou and its docs even better.

Contributing to Jikkou

The Jikkou project itself lives in https://github.com/streamthoughts/jikkou

Code reviews

All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose. Consult GitHub Help for more information on using pull requests.

Creating issues

Alternatively, if there’s something you’d like to see in Jikkou (or if you’ve found something that isn’t working the way you’d expect), but you’re not sure how to fix it yourself, please create an issue.