Skip to content
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# Bug reports and feature requests

You can report an issue in the [Fluss issue tracker](https://github.com/alibaba/fluss/issues).

## Issue Reporting Guide

Considerations before opening an issue:

- Make sure that the issue corresponds to a genuine bug or enhancement request. Exceptions are made for typos in documentation files, which can be reported directly.

- Name the issue in the format "[component] Title of the issue", where *[component]* should be replaced by the name of the component being affected. Typically, this corresponds to areas like [server], [client], [connector], [docs]. Skip *[component]* if you are unsure about which is the best component.

- Fill out the issue template to describe the problem or enhancement clearly. Please describe it such that maintainers understand the context and impact from the description, not only from reproduction steps.

- Make sure that you have searched existing issues to avoid duplicates.

- Each issue should address only one problem or enhancement, not mix up multiple unrelated topics.

## Looking for what to report

- If you have encountered a bug, you can proceed to [the bug reporting process](https://github.com/alibaba/fluss/issues/new?template=bug.yml).
- If you have a feature idea, you can proceed to [the feature request process](https://github.com/alibaba/fluss/issues/new?template=feature.yml).

## How to report a bug

When filing an issue, make sure to answer these five questions:

1. What version of Fluss are you using?
2. What operating system and processor architecture are you using?
3. What did you do?
4. What did you expect to see?
5. What did you see instead?

Troubleshooting questions should be posted on:
* [Slack (#troubleshooting)](https://join.slack.com/t/fluss-hq/shared_invite/zt-33wlna581-QAooAiCmnYboJS8D_JUcYw)
* [GitHub Discussions](https://github.com/alibaba/fluss/discussions)

## How to suggest a feature or enhancement

Fluss aims to provide a unified streaming lakehouse for real-time analytics, offering seamless data ingestion, processing, and querying capabilities with strong consistency guarantees and efficient storage management.

If you're looking for a feature that doesn't exist in Fluss, you're probably not alone. Others likely have similar needs. Please open a [GitHub Issue](https://github.com/alibaba/fluss/issues/new) describing the feature you'd like to see, why you need it, and how it should work.

When creating your feature request, document your requirements first. Please, try to not directly describe the solution.
Loading