This is an automated email from the ASF dual-hosted git repository.
hgruszecki pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/iggy.git
The following commit(s) were added to refs/heads/master by this push:
new 4b184464a feat(repo): add structured YAML issue forms (#2717)
4b184464a is described below
commit 4b184464a8fe4668416d7cad0ce412798ad27998
Author: Hubert Gruszecki <[email protected]>
AuthorDate: Wed Feb 11 09:48:02 2026 +0100
feat(repo): add structured YAML issue forms (#2717)
Replace freeform markdown templates with YAML issue forms
for bug reports, feature requests, and questions. Add
config.yml issues and link to Discord and Discussions.
Simplify PR template prek guidance.
Remove unused BOT_ISSUE_TEMPLATE.md.
---
.github/BOT_ISSUE_TEMPLATE.md | 14 ----
.github/ISSUE_TEMPLATE/bug_report.yml | 104 +++++++++++++++++++++++++++++
.github/ISSUE_TEMPLATE/config.yml | 25 +++++++
.github/ISSUE_TEMPLATE/feature_request.yml | 71 ++++++++++++++++++++
.github/ISSUE_TEMPLATE/question.yml | 41 ++++++++++++
PULL_REQUEST_TEMPLATE.md | 3 +-
6 files changed, 242 insertions(+), 16 deletions(-)
diff --git a/.github/BOT_ISSUE_TEMPLATE.md b/.github/BOT_ISSUE_TEMPLATE.md
deleted file mode 100644
index 8a6e702e2..000000000
--- a/.github/BOT_ISSUE_TEMPLATE.md
+++ /dev/null
@@ -1,14 +0,0 @@
----
-title: Failure of {{ env.GITHUB_BOT_CONTEXT_STRING }} on {{ date |
date('YYYY-MM-DD') }}
-labels: bug
----
-
-## Job failure report
-
-- **Workflow Name**: {{ env.GITHUB_WORKFLOW }}
-- **Run ID**: [{{ env.GITHUB_RUN_ID }}](<https://github.com/{{
env.GITHUB_REPOSITORY }}/actions/runs/{{ env.GITHUB_RUN_ID }}>)
-
-### Description
-
-A failure occurred in the scheduled run of our {{
env.GITHUB_BOT_CONTEXT_STRING }}.
-Please investigate the cause of the failure and take the necessary steps to
resolve it.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml
b/.github/ISSUE_TEMPLATE/bug_report.yml
new file mode 100644
index 000000000..f84636f0f
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -0,0 +1,104 @@
+# 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.
+
+name: Bug Report
+description: Report a bug in Apache Iggy
+labels: ["bug"]
+body:
+ - type: textarea
+ id: description
+ attributes:
+ label: Bug description
+ description: What happened? What did you expect to happen instead?
+ placeholder: |
+ Describe the bug clearly. Include:
+ - What you were doing
+ - What you expected
+ - What actually happened
+ validations:
+ required: true
+
+ - type: dropdown
+ id: deployment
+ attributes:
+ label: Deployment
+ description: How is Iggy server deployed?
+ options:
+ - Docker (DockerHub image)
+ - Docker (self-built image)
+ - Compiled from source
+ - Pre-built binary / release artifact
+ - Not applicable
+ validations:
+ required: false
+
+ - type: input
+ id: versions
+ attributes:
+ label: Versions
+ description: Iggy server and SDK versions. A git tag, commit SHA,
DockerHub tag, or package manager version (crates.io, Maven, NuGet, npm, PyPI)
is also acceptable.
+ placeholder: "e.g., server 0.6.3, Rust SDK 0.8.3, Node.js SDK 0.6.3,
Java SDK 0.6.3, Python SDK 0.6.4"
+ validations:
+ required: false
+
+ - type: input
+ id: hardware
+ attributes:
+ label: Hardware / environment
+ description: Where is this running and what storage is used?
+ placeholder: "e.g., AWS EC2 c5.xlarge with EBS gp3, local PC with NVMe,
GCP n2-standard-4 with ephemeral SSD"
+ validations:
+ required: false
+
+ - type: textarea
+ id: sample-code
+ attributes:
+ label: Sample code
+ description: Producer/consumer initialization and message loop (if
applicable).
+ validations:
+ required: false
+
+ - type: textarea
+ id: logs
+ attributes:
+ label: Logs
+ description: |
+ Relevant logs from the SDK or Iggy server. Server writes to stdout and
to `local_data/logs/iggy-server*`. You can also attach the output of `iggy
snapshot`.
+ validations:
+ required: false
+
+ - type: textarea
+ id: config
+ attributes:
+ label: Iggy server config
+ description: |
+ Your `config.toml` overrides, `local_data/current_config.toml`
(generated by the server on startup with resolved values), or custom `IGGY_*`
environment variables.
+ validations:
+ required: false
+
+ - type: textarea
+ id: reproduction
+ attributes:
+ label: Reproduction
+ description: |
+ Steps to trigger the bug and/or a minimal reproducible project (repo
link or inline script).
+ placeholder: |
+ 1. Start the server with ...
+ 2. Send messages using ...
+ 3. Observe ...
+ validations:
+ required: false
diff --git a/.github/ISSUE_TEMPLATE/config.yml
b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 000000000..fc451bf2b
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,25 @@
+# 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.
+
+blank_issues_enabled: true
+contact_links:
+ - name: Design Discussion
+ url: https://github.com/apache/iggy/discussions
+ about: For bigger features or ideas that need design discussion before
becoming an issue.
+ - name: Support & Chat
+ url: https://discord.gg/apache-iggy
+ about: Ask questions on Discord.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml
b/.github/ISSUE_TEMPLATE/feature_request.yml
new file mode 100644
index 000000000..51f54294a
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.yml
@@ -0,0 +1,71 @@
+# 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.
+
+name: Feature Request
+description: Suggest a new feature or enhancement
+labels: ["feature"]
+body:
+ - type: markdown
+ attributes:
+ value: |
+ > **Tip:** For bigger or exploratory features, consider starting a
[Discussion](https://github.com/apache/iggy/discussions) first to gather
feedback before filing an issue.
+
+ - type: textarea
+ id: description
+ attributes:
+ label: Description
+ description: What do you want and why?
+ placeholder: Describe the feature and the problem it solves.
+ validations:
+ required: true
+
+ - type: dropdown
+ id: component
+ attributes:
+ label: Component
+ description: Which part of the project does this affect?
+ options:
+ - Iggy server
+ - Rust SDK
+ - Go SDK
+ - Java SDK
+ - Python SDK
+ - "C# SDK"
+ - Node.js SDK
+ - CLI
+ - Web UI
+ - Connectors
+ - Documentation
+ - Other
+ validations:
+ required: false
+
+ - type: textarea
+ id: proposed-solution
+ attributes:
+ label: Proposed solution
+ description: If you have a solution in mind, describe it here.
+ validations:
+ required: false
+
+ - type: textarea
+ id: alternatives
+ attributes:
+ label: Alternatives considered
+ description: Other approaches you thought of.
+ validations:
+ required: false
diff --git a/.github/ISSUE_TEMPLATE/question.yml
b/.github/ISSUE_TEMPLATE/question.yml
new file mode 100644
index 000000000..b4ff4c819
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/question.yml
@@ -0,0 +1,41 @@
+# 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.
+
+name: Question
+description: Ask a question about Apache Iggy
+labels: ["question"]
+body:
+ - type: markdown
+ attributes:
+ value: |
+ > **Tip:** For real-time help, try
[Discord](https://discord.gg/apache-iggy).
+
+ - type: textarea
+ id: question
+ attributes:
+ label: Question
+ description: What do you need help with?
+ validations:
+ required: true
+
+ - type: textarea
+ id: context
+ attributes:
+ label: Context
+ description: Relevant code, config, or error output.
+ validations:
+ required: false
diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md
index c1b28bbbc..1d92178f0 100644
--- a/PULL_REQUEST_TEMPLATE.md
+++ b/PULL_REQUEST_TEMPLATE.md
@@ -44,8 +44,7 @@ BAD:
You must run your code locally before submitting.
"Relying on CI" is not acceptable - PRs from authors who haven't run the code
will be closed.
-Did you have `prek` installed? It runs automatically on commit. See
[CONTRIBUTING.md](https://github.com/apache/iggy/blob/master/CONTRIBUTING.md).
-If not installed, explain why (e.g., non-Rust changes only, small change).
+Did you have `prek` installed? It runs automatically on commit and covers all
project languages. See
[CONTRIBUTING.md](https://github.com/apache/iggy/blob/master/CONTRIBUTING.md).
-->
## AI Usage
