kyuubi/.github/ISSUE_TEMPLATE/bug-report.yml
Brian Yue bd0989487d
[KYUUBI #1115] Add Affects Version/s area in bug report issue template
<!--
Thanks for sending a pull request!

Here are some tips for you:
  1. If this is your first time, please read our contributor guidelines: https://kyuubi.readthedocs.io/en/latest/community/contributions.html
  2. If the PR is related to an issue in https://github.com/apache/incubator-kyuubi/issues, add '[KYUUBI #XXXX]' in your PR title, e.g., '[KYUUBI #XXXX] Your PR title ...'.
  3. If the PR is unfinished, add '[WIP]' in your PR title, e.g., '[WIP][KYUUBI #XXXX] Your PR title ...'.
-->

### _Why are the changes needed?_
<!--
Please clarify why the changes are needed. For instance,
  1. If you add a feature, you can talk about the use case of it.
  2. If you fix a bug, you can clarify why it is a bug.
-->
Close #1115.

### _How was this patch tested?_
- [ ] Add some test cases that check the changes thoroughly including negative and positive cases if possible

- [ ] Add screenshots for manual tests if appropriate

- [ ] [Run test](https://kyuubi.readthedocs.io/en/latest/develop_tools/testing.html#running-tests) locally before make a pull request

Closes #1116 from byyue/feature-1115.

Closes #1115

d4513b22 [Brian Yue] Add Affects Version/s area in bug report issue template

Authored-by: Brian Yue <code.byyue@gmail.com>
Signed-off-by: ulysses-you <ulyssesyou@apache.org>
2021-09-22 17:55:06 +08:00

136 lines
4.9 KiB
YAML

#
# 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.
#
# See https://gh-community.github.io/issue-template-feedback/structured/
name: Kyuubi Bug Report
title: "[Bug] "
description: Describe the bug you encountered with Apache Kyuubi
labels: [ "bug" ]
body:
- type: markdown
attributes:
value: |
Thank you for finding the time to report the issue! We really appreciate the community's efforts to improve Kyuubi.
It doesn't really matter whether what you are reporting is a bug or not, just feel free to share the problem you have
encountered with the community. For best practices, if it is indeed a bug, please try your best to provide the reproducible
steps. If you want to ask questions or share ideas, please [subscribe to our mailing list](mailto:dev-subscribe@kyuubi.apache.org)
and send emails to [our mailing list](mailto:dev@kyuubi.apache.org), you can also head to our
[Discussions](https://github.com/apache/incubator-kyuubi/discussions) tab.
- type: checkboxes
attributes:
label: Code of Conduct
description: The Code of Conduct helps create a safe space for everyone. We require that everyone agrees to it.
options:
- label: >
I agree to follow this project's [Code of Conduct](https://www.apache.org/foundation/policies/conduct)
required: true
- type: checkboxes
attributes:
label: Search before asking
options:
- label: >
I have searched in the [issues](https://github.com/apache/incubator-kyuubi/issues?q=is%3Aissue) and found no similar
issues.
required: true
- type: textarea
attributes:
label: Describe the bug
placeholder: >
Please provide the context in which the problem occurred and explain what happened
validations:
required: true
- type: input
id: versions
attributes:
label: Affects Version(s)
description: Which versions of Kyuubi are affected by this bug?
placeholder: >
e.g. master/1.3.0/1.2.0/...
validations:
required: true
- type: textarea
id: s-logs
attributes:
label: Kyuubi Server Log Output
description: What do you see when you check the log of Kyuubi server instance?
placeholder: >
Tips: check the server log under the KYUUBI_HOME/logs/ folder. It is extremely helpful if you copy and paste
the fragment of logs showing the exact error messages of Kyuubi server.
render: logtalk
validations:
required: false
- type: textarea
id: e-logs
attributes:
label: Kyuubi Engine Log Output
description: What do you see when you check the log of Kyuubi engine instance?
placeholder: >
Tips: check the engine log under the KYUUBI_HOME/work/[username]/ folder. It is extremely helpful if you copy and paste
the fragment of logs showing the exact error messages of Kyuubi engines.
render: logtalk
validations:
required: false
- type: textarea
id: s-configurations
attributes:
label: Kyuubi Server Configurations
placeholder: >
Custom configurations you specified in kyuubi-defaults.conf at server-side
render: yaml
validations:
required: false
- type: textarea
id: e-configurations
attributes:
label: Kyuubi Engine Configurations
placeholder: >
Custom configurations you specified in spark-defaults.conf at engine-side
render: yaml
validations:
required: false
- type: textarea
attributes:
label: Additional context
placeholder: Anything else we need to know.
validations:
required: false
- type: checkboxes
attributes:
label: Are you willing to submit PR?
description: >
A pull request is optional, but we are glad to help you in the contribution process
especially if you already know a good understanding of how to implement the fix.
Kyuubi is a community-driven project and we love to bring new contributors in.
options:
- label: Yes I am willing to submit a PR!
- type: markdown
attributes:
value: "Thanks for taking the time to fill out this bug report!"