-
Notifications
You must be signed in to change notification settings - Fork 518
[website] create a seperate page for bug report & feature request #1213
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
polyzos
merged 5 commits into
apache:main
from
MehulBatra:seperate_page_feature_request
Jul 10, 2025
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
f379841
Create a seperate page for bug report & feature request
MehulBatra b9fd61c
change wordings
MehulBatra 1d35a2c
address giannis comments
MehulBatra 52d1139
address jark comments
MehulBatra 3e7143a
address giannis comment
MehulBatra File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
72 changes: 72 additions & 0 deletions
72
website/community/how-to-contribute/bug-reports-feature-requests.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,72 @@ | ||
| --- | ||
| title: Bug Reports and Feature Requests | ||
| sidebar_position: 1 | ||
| --- | ||
|
|
||
| <!-- | ||
| Licensed to the Apache Software Foundation (ASF) under one | ||
| or more contributor license agreements. See the NOTICE file | ||
| distributed with this work for additional information | ||
| regarding copyright ownership. The ASF licenses this file | ||
| to you under the Apache License, Version 2.0 (the | ||
| "License"); you may not use this file except in compliance | ||
| with the License. You may obtain a copy of the License at | ||
|
|
||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
|
|
||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| --> | ||
|
|
||
| # Bug Reports and Feature Requests | ||
|
|
||
| You can report an issue in the [Fluss issue tracker](https://github.com/apache/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. | ||
|
|
||
| - Provide a clear and descriptive title. Use component labels (such as `component=server`, `component=client`, `component=connector`, `component=docs`) to help categorize your issue and make it easier to filter and search. | ||
|
|
||
| - 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/apache/fluss/issues/new?template=bug.yml). | ||
| - If you have a feature idea, you can proceed to [the feature request process](https://github.com/apache/fluss/issues/new?template=feature.yml). | ||
|
|
||
| ## How to report a bug | ||
|
|
||
| When filing an issue, make sure to answer these five questions: | ||
|
|
||
| **Environment:** | ||
| 1. What version of Fluss are you using? | ||
| 2. What operating system and processor architecture are you using? | ||
|
|
||
| **Steps to reproduce:** | ||
| 3. What did you do? | ||
|
|
||
| **Expected vs Actual behavior:** | ||
| 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/apache/fluss/discussions) | ||
|
|
||
| ## How to suggest a feature or enhancement | ||
MehulBatra marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| Fluss aims to provide a unified streaming storage 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/apache/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, start by clearly documenting your requirements and avoid jumping straight to implementation details. For substantial features or architectural changes that need broader community input, consider submitting a [Fluss Improvement Proposal (FIP)](https://cwiki.apache.org/confluence/display/FLUSS/Fluss+Improvement+Proposals). FIPs offer a formal process to propose, discuss, and document significant project enhancements. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.