apache / apache/fluss

[Feature] Add a local development kit for contributors

Open
#3,850 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Java
Stars
2.1k
Forks
625
Avg merge
3d 14h
Merged PRs (30d)
97

Description

## Motivation

I recently started contributing to Fluss. The build process is clear and the documentation is comprehensive, while most existing guides focus on deployment and usage scenarios. After changing code, running locally built artifacts and validating Flink or lake tiering still requires manually combining several services, configurations, and dependencies.

I am also exploring using coding agents to start environments and validate test cases, which benefits from a stable, clear, and repeatable local interface.

## Solution

I put together a DevKit based on Docker Compose and `just`. It mounts the local `build-target`, manages integration environments through profiles, and provides composable commands for startup and validation.

The DevKit focuses on source development and local validation, alongside the existing quickstarts and deployment guides. A Draft PR provides a working implementation for discussion. Feedback on the direction, tool choice, and maintenance scope would be appreciated.

I am willing to submit a PR.

Contributor guide

No contributing guide indexed for this repository

Research direction

Review the draft PR's Docker Compose and `just` DevKit, starting with how it mounts `build-target` and manages integration environments through profiles. Run the provided startup and validation commands for Flink and lake-tiering scenarios; done means contributors can repeatedly start local environments and validate locally built artifacts without manually combining services, configurations, and dependencies.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker-compose, java
Domain
developer-experience, devops, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.