You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by cl...@apache.org on 2023/08/25 17:23:11 UTC

[camel-k] branch main updated: Add GH Issue Template (#4689)

This is an automated email from the ASF dual-hosted git repository.

claudio4j pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel-k.git


The following commit(s) were added to refs/heads/main by this push:
     new 2a05b7374 Add GH Issue Template (#4689)
2a05b7374 is described below

commit 2a05b7374a7b4945f29cad81778f1dc9a1ab80da
Author: Anish Rajan <an...@gmail.com>
AuthorDate: Fri Aug 25 22:53:05 2023 +0530

    Add GH Issue Template (#4689)
    
    * added github issue template
    
    * add additional information for users
    
    * updated bug report template
---
 .github/ISSUE_TEMPLATE/bug_report.yaml      | 62 +++++++++++++++++++++++++++++
 .github/ISSUE_TEMPLATE/config.yml           |  8 ++++
 .github/ISSUE_TEMPLATE/feature_request.yaml | 48 ++++++++++++++++++++++
 3 files changed, 118 insertions(+)

diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml
new file mode 100644
index 000000000..c64d8f471
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.yaml
@@ -0,0 +1,62 @@
+name: Bug Report
+description: Create a report to help us improve
+title: "[Bug]: "
+labels: ["kind/bug"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Welcome to Apache Camel K! 👋🎉 Thanks for taking the time to fill out this bug report.
+
+        Before you post:
+        - Please search for existing issues to avoid creating duplicate bugs/feature requests.
+        - Please be respectful and considerate of others (see [Apache Code of Conduct](https://www.apache.org/foundation/policies/conduct)).
+        - If you only have a question, you may get a faster response by asking in [our Zulip chat room](https://camel.zulipchat.com/login/) or [mailing list](https://camel.apache.org/community/mailing-list/).
+
+        Additional information helps us troubleshoot the issue faster.
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: What happened?
+      description: |
+        Please describe the problem you are experiencing. What is not working?
+        Try to focus on the functional aspect of the issue, rather than technical details.
+      placeholder: |
+        While [description of the action/steps taken]
+        I noticed [description of the issue/bug]
+        as a result of that [impact].
+    validations:
+      required: true
+  - type: textarea
+    id: reproduce
+    attributes:
+      label: Steps to reproduce
+      description: How can we reproduce the issue?
+      placeholder: |
+        1.
+        2.
+        3.
+  - type: textarea
+    id: logs
+    attributes:
+      label: Relevant log output
+      description: |
+        Please copy and paste any relevant log output.
+        This will be automatically formatted into code, so no need for backticks.
+        Please indicate from which component the logs originate.
+        - _**How to get camel-k-operator log**: `kubectl logs -f $(k get pod -l app=camel-k -o name)`_
+        - _**Note:** Verify the namespace/platform where camel-k is installed. The builder pod name can vary by platform (e.g., in OpenShift, it's `camel-k-kit`)._
+      render: shell
+  - type: markdown
+    attributes:
+      value: |
+        ## Camel K setup
+        Please describe your Camel K setup.
+  - type: input
+    id: version
+    attributes:
+      label: Camel K version
+      description: |
+        Which version of the Camel K are you running?
+        _Verify if the Kamel CLI is the same version as the Camel-K-Operator with `kamel version -a`_
+      placeholder: "Ex: v1.12.1"
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 000000000..b6423007f
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,8 @@
+blank_issues_enabled: false
+contact_links:
+  - name: "Question via Camel K Zulip Chat"
+    url: https://camel.zulipchat.com/login/
+    about: "Please ask and answer questions here for faster response. If you don't have an account, sign up at https://camel.zulipchat.com/register/"
+  - name: "Question via Mailing List"
+    url: https://camel.apache.org/community/mailing-list/
+    about: "Please subscribe to the mailing list of your choice."
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml
new file mode 100644
index 000000000..0f1831e4c
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.yaml
@@ -0,0 +1,48 @@
+name: Feature Request
+description: Suggest an idea for this project
+title: "[Feature]: "
+labels: ["kind/feature"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Welcome to Apache Camel K! 👋🎉 Thanks for taking the time to fill out this feature request.
+
+        Before you post:
+        - Please search for existing issues to avoid creating duplicate bugs/feature requests.
+        - Please be respectful and considerate of others (see [Apache Code of Conduct](https://www.apache.org/foundation/policies/conduct)).
+        - If you only have a question, you may get a faster response by asking in [our Zulip chat room](https://camel.zulipchat.com/login/) or [mailing list](https://camel.apache.org/community/mailing-list/).
+
+        Additional information helps us troubleshoot the issue faster.
+  - type: textarea
+    id: requirement
+    attributes:
+      label: Requirement
+      description: What kind of business use case are you trying to solve?
+      placeholder: |
+        As a [description of a user persona]
+        I want [functionality]
+        so that [benefit].
+    validations:
+      required: true
+  - type: textarea
+    id: problem
+    attributes:
+      label: Problem
+      description: |
+        What in Camel K blocks you from solving the requirement?
+        If possible, describe the impact of the problem.
+    validations:
+      required: true
+  - type: textarea
+    id: proposal
+    attributes:
+      label: Proposal
+      description: |
+        What do you suggest to solve the problem or improve the existing situation?
+        It's ok if you don't have one.
+  - type: textarea
+    id: questions
+    attributes:
+      label: Open questions
+      description: Questions that should be answered before proceeding with implementation.